diff options
Diffstat (limited to 'Data/BuiltIn/Libraries/lua-addons/addons/Treasury/ReadMe.md')
-rw-r--r-- | Data/BuiltIn/Libraries/lua-addons/addons/Treasury/ReadMe.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/Data/BuiltIn/Libraries/lua-addons/addons/Treasury/ReadMe.md b/Data/BuiltIn/Libraries/lua-addons/addons/Treasury/ReadMe.md new file mode 100644 index 0000000..0b23864 --- /dev/null +++ b/Data/BuiltIn/Libraries/lua-addons/addons/Treasury/ReadMe.md @@ -0,0 +1,52 @@ +# Treasury + +An addon that manages the treasure pool for you and keeps your inventory clean of unwanted items. It does three things: +1. It lots/passes on items in the treasure pool based on per-character rules as defined in the settings file +2. It automatically stacks items in your inventory after it changes, if enabled +3. If automatically drops unwanted items from your inventory, if enabled + +### Commands + +Note: +All commands can be shortened to `//tr`. `lot` and `pass` can be shortened to `l` and `p` respectively. `add` and `remove` can be shortened to `a` or `+` and `r` or `-` respectively. + +`//treasuy lot|pass|drop add|remove [global] <name>` + +This will add to or remove from the lot list, pass list or drop list all items matching `name`. `name` can contain standard Windower wildcards (`*`, `?`, `|`). It will add those for the current character only, unless `global` is specified, in which case it will add it for all characters. + +There are a few special key words for `name`: +* `crystals` matches all crystal items (excluding HQ synthing crystals) +* `geodes` matches all geode items (NQ) +* `avatarites` matches all geode items (HQ) +* `currency` matches all Dynamis currency (all three tiers of all three kinds) +* `seals` matches the standard seals found in the field (BS, KS, KC, HKC, SKC) +* `detritus` matches Swart Astral Detritus and Murky Astral Detritus +* `heroism` matches Heroism Crystal and Heroism Aggregate +* `moldy` matches all Moldy weapons and neck items from Dynamis Divergence +* `dynad` matches all three card types, all three medal types, and the crafting materials from Dynamis Divergence +* `papers` matches all shards and all void items from Dynamis Divergence +* `pool` matches your current treasure pool + +'//treasury lot|pass|drop clear|list` + +This will either clear the specified list (for the current character only) or list all items on the specified list. + +`//treasury lotall|passall` + +Lots/passes on all items currently in the pool + +`//treasury clearall` + +Clears all character-specific settings (it will keep global settings) + +`//treasury delay <value>` + +Sets the delay that should pass before lotting/passing/dropping items, in seconds. It will lot/pass/drop items in a random time interval between half the value specified and the full value. I.e. if you specify 5 seconds it will lot/pass/drop between 2.5 seconds and 5 seconds randomly. + +`//treasury <autodrop|autostack|verbose> [on|off]` + +Sets the provided setting to true or false. If neither is provided, it toggles the current setting. + +`//treasury save` + +Saves the current character's settings for all characters. |