From a4d05d076d1a73be6660ebacbeeabd7d78752158 Mon Sep 17 00:00:00 2001 From: lili-ffxi <40600148+lili-ffxi@users.noreply.github.com> Date: Sun, 2 Feb 2025 14:03:36 +0000 Subject: [PATCH] Update README.md Fixed markdown Added the newer options for the `export` command. --- addons/GearSwap/README.md | 42 ++++++++++++++++++++++----------------- 1 file changed, 24 insertions(+), 18 deletions(-) diff --git a/addons/GearSwap/README.md b/addons/GearSwap/README.md index 650af8511d..bf829f04ce 100644 --- a/addons/GearSwap/README.md +++ b/addons/GearSwap/README.md @@ -1,6 +1,6 @@ Author: Byrth -Version: 0.930 +Version: 0.938 Date: 06/13/2017 @@ -9,27 +9,33 @@ GearSwap Abbreviation: gs Commands (<> indicates a field. You do not actually have to use <>s): -* gs c : Passes the to the self_command() user function. -* gs equip : Attempts to interpret the as an index of the sets table and equip that set. Will ignore "sets" if the string starts with it. +* gs c \ : Passes the to the self_command() user function. +* gs equip \ : Attempts to interpret the as an index of the sets table and equip that set. Will ignore "sets" if the string starts with it. ** gs equip naked : This equips the default set "naked," which is just a bunch of empty slots. If you remake sets (sets={}) in your get_sets(), this will not work. * gs debugmode : Activates GearSwap's Debug Mode, which prints out why specific gear equipping attempts failed, shows you when you're entering events, and enables the eval command. -** gs eval : This command evaluates the as Lua code in the global gearswap environment (not the user environment, which is in the user_env table). It is only available when debugmode is on. +** gs eval \ : This command evaluates the as Lua code in the global gearswap environment (not the user environment, which is in the user_env table). It is only available when debugmode is on. * gs showswaps : Shows when your gear successfully changes and what it changes to. -* gs load : (or l ) Attempts to load the first version of found, assuming it is a file path relative to 9 potential base directories, in this order: -** ..GearSwap/libs-dev/ -** ..GearSwap/libs/ -** GearSwap/data// -** GearSwap/data/common/ -** GearSwap/data/ -** APPDATA/Windower/GearSwap// -** APPDATA/Windower/GearSwap/common/ -** APPDATA/Windower/GearSwap/ -** ..Windower/addons/libs/ +* gs load \ : (or l ) Attempts to load the first version of found, assuming it is a file path relative to 9 potential base directories, in this order: + * ..GearSwap/libs-dev/\ + * ..GearSwap/libs/\ + * GearSwap/data/\/\ + * GearSwap/data/common/\ + * GearSwap/data/\ + * APPDATA/Windower/GearSwap/\/\ + * APPDATA/Windower/GearSwap/common/\ + * APPDATA/Windower/GearSwap/\ + * ..Windower/addons/libs/\ * gs reload : Reloads the current user file. -* gs export : Exports your currently equipped gear, inventory, or all the items in your current Lua files' sets into GearSwap .lua or spellcast .xml format. Takes options "inventory", "all", "wearable", "sets", and "xml." Defaults to currently equipped gear and lua otherwise. Also exports appropriate advanced set tables with augments for currently equipped gear and inventory. -* gs enable : Enables equip commands targeting a specified slot. "All" will allow all equip commands. Providing no slot argument will enable user GearSwap file execution, if it was disabled. -* gs disable : Disables equip commands targeting a given slot. "All" will prevent all equip commands. Providing no second argument will disable user GearSwap file execution, although registered events will still run. -* gs validate : This command checks to see whether the equipment in the sets table also exists in your inventory (default), or (by passing "inv") whether the equipment in your inventory exists in your sets table. is an optional list of words that restricts the output to only those items that contain text from one of the filter's words. +* gs export \ : Exports your currently equipped gear, inventory, or all the items in your current Lua files' sets into GearSwap .lua format. + Available options: + * one of "inventory", "all", "wearable", "sets". Defaults to currently equipped gear and lua otherwise. + * "noaugments", to export only base names and omit augments, or "only augments"m to export only gear that is augmented. These two options are mutually exclusive. Defaults to exporting all gear with the respective augments (if present) if neither is specified. + * "minify", exports the set in a single line without newlines. + * "clipboard", exports the set to clipboard instead of a file. + * "filename", followed by the desired name, exports to the specified filename. Defaults to "Charactername_YYYY-MM-DD HH:MM:SS.lua" otherwise. Does nothing if "clipboard" is passed. +* gs enable \ : Enables equip commands targeting a specified slot. "All" will allow all equip commands. Providing no slot argument will enable user GearSwap file execution, if it was disabled. +* gs disable \ : Disables equip commands targeting a given slot. "All" will prevent all equip commands. Providing no second argument will disable user GearSwap file execution, although registered events will still run. +* gs validate \ \ : This command checks to see whether the equipment in the sets table also exists in your inventory (default), or (by passing "inv") whether the equipment in your inventory exists in your sets table. \ is an optional list of words that restricts the output to only those items that contain text from one of the filter's words. Purpose: To assist in the micromanaging of equipment!