Skip to content

Commit

Permalink
updated readme;
Browse files Browse the repository at this point in the history
minor fixes
  • Loading branch information
Tylas11 committed Aug 18, 2020
1 parent 703fad0 commit 5c86576
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 25 deletions.
51 changes: 28 additions & 23 deletions README.md
Expand Up @@ -6,47 +6,52 @@ Shows party members' HP/MP/TP, main job, sub job and current buffs. Buffs can be
![Screenshot](https://i.imgur.com/VtnZmB0.jpg)

## Installation
* Copy all files in the repo to Windower4/addons/XivParty
* Load using //lua load xivparty
* RECOMMENDED: Download and install the free font '[Grammara](https://www.fontspace.com/grammara-font-f4454)' for a more authentic FF14 look of the numbers
* Download the [latest release](https://github.com/Tylas11/XivParty/releases) and extract it to Windower4/addons
* Load using "//lua load xivparty" in the chat window
* To load the addon automatically when the game starts, edit Windower4/scripts/init.txt and add "lua load xivparty" at the end
* RECOMMENDED: Download and install the free font "[Grammara](https://www.fontspace.com/grammara-font-f4454)" for a more authentic FF14 look of the numbers (restart Windower afterwards, or it won't find the newly installed font)

## Commands

| Command | Action |
| --- | --- |
| //xp filter add [ID] | Adds filter for buff with specified ID. |
| //xp filter remove [ID] | Removes filter for buff with specified ID. |
| //xp filter clear | Clears all buff filters. |
| //xp filter list | Shows list of all current filters in log window. |
| //xp filter mode | Switches between blacklist and whitelist filter mode (both use same filter list).
| //xp buffs [name] | Shows list of currently active buffs (and IDs) for a party member. Omit name to see own buffs. |
| //xp range [distance] | Shows a marker for each party member closer than the set distance. 'Off' or '0' to disable. |
| //xp customOrder | Toggles custom buff ordering (customize in bufforder.lua). |
| //xp hideSolo | Hides the party list while solo. |
| //xp move | Move the UI via drag and drop, use mouse wheel to adjust space between party members. |
| //xp layout [file] | Loads a UI layout file from the XivParty/layouts directory. Omit file extension. Use \'auto\' to enable resolution based selection (for preset layouts only). |
| Command | Action |
| ----------------------- | ---------------------------------------------------------------------------------------------- |
| //xp filter add [ID] | Adds filter for buff with specified ID. |
| //xp filter remove [ID] | Removes filter for buff with specified ID. |
| //xp filter clear | Clears all buff filters. |
| //xp filter list | Shows list of all current filters in log window. |
| //xp filter mode | Switches between blacklist and whitelist filter mode (both use same filter list). |
| //xp buffs [name] | Shows list of currently active buffs (and IDs) for a party member. Omit name to see own buffs. |
| //xp range [distance] | Shows a marker for each party member closer than the set distance. "off" or "0" to disable. |
| //xp customOrder | Toggles custom buff ordering (customize in bufforder.lua). |
| //xp hideSolo | Hides the party list while solo. |
| //xp move | Move the UI via drag and drop, use mouse wheel to adjust space between party members. |
| //xp layout [file] | Loads a UI layout file from the XivParty/layouts directory. Omit file extension. <br/> Use "auto" to enable resolution based selection (for default layouts only). |

## Range Indication
The distance to party members is indicated by dimming their HP bars in two stages: out of standard casting range (~20.8) and out of targeting range (50).

There is also a customizable range indicator useful when casting aoe buffs. Set the desired distance with the 'range' command and any party member closer than this distance will have a small diamond icon displayed below their HP bar. The main player will always have this icon displayed when the feature is active. Set to range 0 or 'off' to disable.
There is also a customizable range indicator useful when casting aoe buffs. Set the desired distance with the "range" command and any party member closer than this distance will have a small diamond icon displayed below their HP bar. The main player will always have this icon displayed when the feature is active. Set to range "0" or "off" to disable.

## Custom Buff Ordering
By default buffs are ordered debuffs first, then buffs by various categories. This can be disabled to revert to the game's original ordering, which is sometimes random and based on when the buff was added to the game.

You can customize the sorting order by editing the file 'bufforder.lua'. Just reorder the lines of the list. Do not change the IDs. The name strings are not used by the addon and are only there for readability. Save the file as UTF-8 without BOM or ANSI (however this will destroy the Japanese translations).
You can customize the sorting order by editing the file bufforder.lua. Just reorder the lines of the list. Do not change the IDs. The name strings are not used by the addon and are only there for readability. Save the file as UTF-8 without BOM or ANSI (however this will destroy the Japanese translations).

## Creating Custom Layouts
A layout consists of an XML file in XivParty/layouts and image files in XivParty/assets. Constants defining positions, offsets, sizes, fonts and colors of various UI elements are exposed in the XML file, so editing the LUA files should not be necessary in most cases.

You can set the color and alpha for every image, font and font outline (stroke) individually using a hexadecimal color code in the format #RRGGBBAA. Offsets, spacings and sizes are set in a single comma separated parameter, where the first number is either the X position or width and the second is Y or height.

For further details, check out the comments in layout.lua.

#### Background
Consists of a fixed top and bottom image, and a center (mid) texture that repeats vertically when the party list expands. All background images must have the same width, top and bottom must have the same height.
Consists of a fixed top and bottom image, and a center (mid) texture that repeats vertically when the party list resizes. When using repeating patterns, make the mid texture height as low as possible, as it can only repeat in full height steps and will be slightly compressed in between.
#### Bars
The HP/MP/TP bars all use the same images and consist of a background and a foreground part. The foreground image is centered inside the background in code and should not have a transparent frame around it, or scaling will not look good when the bar's value changes.
#### Fonts
You can use any system installed font, make sure to restart Windower after installing new fonts. The parameters text.color and text.stroke affect all fonts.
The HP/MP/TP bars each use a background and foreground image which can be set separately for all three bars. The foreground image is centered inside the background in code and should not have a transparent frame around it, or horizontal scaling will not look good when the bar's value changes.
#### Texts
Most texts can be configured separately, only the HP/MP/TP numbers share the same settings. There are additional font colors when the TP bar fills up or when HP drops below certain percentages. You can use any system installed font, but make sure to restart Windower after installing new fonts or they wont be detected. If a font is not found, it will fall back to Arial.
#### Resizing Layouts
Set the 'scale' parameter to adjust the size of all images. This will not affect any offsets, spacings or fonts so they have to be adjusted manually. Alternatively leave the scale at 1, resize the image files and set their new width / height in the XML.
Set the "scale" parameter to adjust the size of all images. This will not affect any offsets, spacings or fonts so they have to be adjusted manually. Alternatively leave the scale at 1, resize the image files and set their new size in the XML. It is also possible to override the scale of individual images by adjusting their "size" parameter.

## Acknowledgments
* SirEdeonX (xivbar) - early prototype based on xivbar's code
Expand Down
2 changes: 1 addition & 1 deletion bg.lua
Expand Up @@ -86,7 +86,7 @@ function bg:resize(rowCount)
self:pos(self.posX, self.posY) -- refresh position of bottom tile

-- visible size of the whole background area
self.size.width = self.top:scaledSize().width
self.size.width = math.max(math.max(self.top:scaledSize().width, self.bottom:scaledSize().width), self.mid:scaledSize().width)
self.size.height = self.top:scaledSize().height + self.mid:scaledSize().height + self.bottom:scaledSize().height
end

Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion xivparty.lua
Expand Up @@ -321,7 +321,7 @@ end
function loadLayout(layoutName)
if layoutName == layoutAuto then
local resY = windower.get_windower_settings().ui_y_res
if resY <= 1080 then
if resY <= 1200 then
layoutName = layout1080
else
layoutName = layout1440
Expand Down

0 comments on commit 5c86576

Please sign in to comment.