Differences

This shows you the differences between two versions of the page.

--- materialgirl [2023/10/20 14:21] – [Settings Tab] mistahmikey
+++ materialgirl [2026/01/10 18:47] (current) – mistahmikey
@@ Line 1: / Line 1: @@
+======= Material Girl (MG) =======
 {{:mistahmikey:materialgirl:materialgirl.jpg?400|}}
 ===== What it does =====
-Provides a wide variety of functions for you to manage items in your various inventory bags: Main Inventory, Equipped Items, Armory, Saddlebags, and Retainer bags.
+Material Girl (MG) provides a wide variety of functions for you to manage items in your various inventory bags: Main Inventory, Equipped Items, Armory, Saddlebags, Retainer bags, and Company Chest bags.
-  * Allows you to easily apply functions to multiple selected items in your inventories (if they are supported by the bag type): Extract Materia, Retrieve Materia, Desynthesize, Repair (using dark matter or a mender), Use, Discard, Merge, Sell, Expert Delivery
+  * Allows you to easily apply functions to multiple selected items in your inventories (if they are supported by the bag type): Save (current selected inventory to CSV file), Extract Materia, Retrieve Materia, Desynthesize, Repair (using dark matter or a mender), Use, Discard, Merge, Sell, Expert Delivery
   * Allows you to automatically handover required items during certain transactions with NPCs.
-  * Allows you to trade unlimited (as governed by the recipient's inventory space) selected items or gil to another character running Material Girl.
+  * Allows you to trade unlimited (as governed by the recipient's inventory space) selected items or gil to another character running MG.
   * Allows you to move multiple selected items between any of your bags.
   * Allows you to synchronize equipment in your armory by setting and saving the recommended gear for every gearset you have.
@@ Line 13: / Line 14: @@
   * Allows you to filter specific item subsets in your inventories for viewing and/or manipulating via a powerful filter expression language. Filter expressions can be saved for future recall and use.
-Regarding the filter expression language. Say you have 100 equipment items in your inventory, and you wanted to see only those items that were for a Sage or a Monk, but with an ilevel greater than 480.  You could do that with the following filter expression:  **(SGE or MNK) and ilevel > 480**.   Or maybe you want to sell off a bunch of junk you've accumulated while botting dungeons.  You might select those items using a filter expression (which is one I actually use) such as: **sellable and (cloth or stone or reagent or lumber or metal or ingredient or leather or demimateria or medicine or bone or seafood)**, and then use the Sell function. You can also filter items by name, using exact match or LUA patterns.  Perhaps you only want to see all the Craftsman's materia in your inventories to trade them to your alt.  You could select them with the filter expression: **/Craft.*Materia/** and the use the Trade function to trade them all to your targeted alt. The filter expression language, a unique feature of Material Girl, is extensive and supports the arbitrary grouping of subexpressions via parenthesis and boolean logic. This powerful feature is fully described in the Filter Expression section.
+Regarding the filter expression language. Say you have 100 equipment items in your inventory, and you wanted to see only those items that were for a Sage or a Monk, but with an ilevel greater than 480.  You could do that with the following filter expression:  **(SGE or MNK) and ilevel > 480**.   Or maybe you want to sell off a bunch of junk you've accumulated while botting dungeons.  You might select those items using a filter expression (which is one I actually use) such as: **sellable and (cloth or stone or reagent or lumber or metal or ingredient or leather or demimateria or medicine or bone or seafood)**, and then use the Sell function. You can also filter items by name, using exact match or LUA patterns.  Perhaps you only want to see all the Craftsman's materia in your inventories to trade them to your alt.  You could select them with the filter expression: **/Craft.*Materia/** and the use the Trade function to trade them all to your targeted alt. The filter expression language, a unique feature of MG, is extensive and supports the arbitrary grouping of subexpressions via parenthesis and Boolean logic. This powerful feature is fully described in the Filter Expression section.
@@ Line 20: / Line 21: @@
 You must also download MistahMikeysLib from the store. It's free, of course.
-Currently, Material Girl only supports FFXIV 6.x, and only in English.
+MG supports the following languages: EN.
-You must ensure FFXIV, Minion, and Material Girl are always updated to their latest versions.
+You must ensure FFXIV, Minion, and MG are always updated to their latest versions.
-To use the automatic functions provided by Material Girl, you must ensure you have turned off conflicting functions (materia extraction, repair, and desynthesizing) of other Addons you are running, or bad things might happen.
+To use the automatic functions provided by MG, you must ensure you have turned off conflicting functions (materia extraction, repair, and desynthesizing) of other Addons you are running, or bad things might happen.
 __**IMPORTANT**__
-Material Girl provides some powerful options to manage your inventories, but with great power comes great responsibility. Material Girl requires you to be extremely careful when you use destructive functions like discard or desynthesize.  While it will try to help you not do the wrong thing by prompting you to continue before you attempt destructive operations, you still need to pay attention, especially in automatic mode.  So, for example, if you enable automatic desynthesizing, forget to turn it off after you're done running dungeons, and then buy that really expensive piece of gear you've been saving up for, Material Girl will turn it into detritus as soon as it hits your inventory. Material Girl will detect if you begin to craft in automatic desynthesize mode, and will automatically disable it (you an override this behavior in settings if you wish to level desynthesis.) But if you get lazy or sloppy while using destructive functions, you might lose cherished items.  So be careful out there - you have been warned.
+MG provides some powerful options to manage your inventories, but with great power comes great responsibility. MG requires you to be extremely careful when you use destructive functions like discard or desynthesize.  While it will try to help you not do the wrong thing by prompting you to continue before you attempt destructive operations, you still need to pay attention, especially in automatic mode.  So, for example, if you enable automatic desynthesizing, forget to turn it off after you're done running dungeons, and then buy that really expensive piece of gear you've been saving up for, MG will turn it into detritus as soon as it hits your inventory. MG will detect if you begin to craft in automatic desynthesize mode, and will automatically disable it (you an override this behavior in settings if you wish to level desynthesis.) But if you get lazy or sloppy while using destructive functions, you might lose cherished items.  So be careful out there - you have been warned.
 ====== UI ======
-You start Material Girl via the FFXIVMinion menu drop down. It's under the "MistahMikey" menu item.  Clicking "Material Girl" should pop up its UI window.  The UI consists of different input areas called tabs that are selected by clicking the tab name that appears on the first line of the UI.  Each tab is described below.
+You start MG via the FFXIVMinion menu drop down. It's under the "MistahMikey" menu item.  Clicking "Material Girl" should pop up its UI window.  The UI consists of different input areas called tabs that are selected by clicking the tab name that appears on the first line of the UI.  Each tab is described below.
 ===== Main Tab =====
@@ Line 46: / Line 47: @@
 These controls activate features generally not related to manipulating specific items you select from your inventories.
-| Enable | When checked, enables Material Girl to run. |
+| Enable | When checked, enables MG to run. |
-| Auto Inventory Management | When checked, Material Girl will run in automatic inventory management mode (described below.) |
+| Auto Inventory Management | When checked, MG will run in automatic inventory management mode (described below.) |
 | Reset | Resets all settings to their default initial values. You can use this to abort certain operations you've started if you can catch it in time. If you have a current profile set, and Load Current Profile After Reset (Profile Tab) is enabled, then your saved profile values will be loaded.  The Reset button will disappear while the reset is in progress, and will reappear when it completes. |
-| Discord Icon | Takes you to the Material Girl Discord channel if you need support.  Be advised I am in the Eastern Time zone (UTC-05:00). |
+| Discord Icon | Takes you to the MG Discord channel if you need support.  Be advised I am in the Eastern Time zone (UTC-05:00). |
-| Sync Gearsets | When clicked, Material Girl will set the FFXIV recommended equipment for selected gearsets from your FFXIV gearset list. You specify the gearsets to be synchronized via the Gearsets tab. |
+| Sync Gearsets | When clicked, MG will set the FFXIV recommended equipment for selected gearsets from your FFXIV gearset list and save the gearset. You specify the gearsets to be synchronized via the Gearsets tab. |
-| Clean Armory | When clicked, Material Girl will transfer all equipment from your Equipment inventories that are not assigned to a gearset into your inventory bags.  It will visit every gearset in your FFXIV gearset list to catalog the equipment it uses. You can also request each gearset first be synchronized before it is cataloged (specified in the Settings Tab; by default, it is disabled.)  After it has visited every gearset, it will move as much unassigned equipment into your inventory bags as space allows. If you do not have sufficient space, you will need to execute Clean Armory multiple times.  Because of how items are identified in the game, it is not possible to determine if multiple rings of the same type are truly assigned to a gearset or not.  You will see messages in the Minion Console when this occurs, which you can use to determine if you manually need to remove specific rings. |
+| Clean Armory | When clicked, MG will transfer all equipment from your Equipment inventories that are not assigned to a gearset into your inventory bags.  You can also request each gearset first be synchronized before cleaning takes place (specified in the Settings Tab; by default, it is disabled.)  MG will move as much unassigned equipment into your inventory bags as space allows. If you do not have sufficient space, you will need to make additional space and execute Clean Armory multiple times. Here is how I recommend you use the Clean Armory feature.  If you know your current gearsets are synced - i.e., they are up to date and represent the best equipment you can assign to them - then just run Clean Armory directly.  Otherwise, first run Sync Gearsets - which will visit every gearset to ensure the recommended equipment for each gearset is chosen and saved - then, run Clean Armory.  If you have more armory items to move into your inventory bags than space available, you will need to subsequently create some space by getting rid of the equipment currently there - perhaps by desynthesizing, selling, or moving them to retainers/saddlebags - then, you can just run Clean Armory again and it will quickly move the next set of equipment into the newly available space.  Be aware that only equipment that is actually in your armory bags is considered for movement, so any equipped equipment items will not be considered, even though those equipment items may not be in any gearset (generally a rare situation.)   If you want to move those ungearseted equipped equipment items out as well, then simply equip a different gearset and run Clean Armory again.|
-| Trade Gil | When clicked, Material Girl will trade the amount of Gil you specify in the Gil to Trade control to the player you have targeted. FFXIV limits the amount of Gil that can be transferred in a single trade to 1M, but Material Girl will initiate multiple trades to trade amounts greater than 1M.  If you run Material Girl on the recipient using Auto Trade mode (specified in the Settings Tab; by default, it is disabled), then the entire amount of Gil you requested to be traded will be transferred automatically. |
+| Trade Gil | When clicked, MG will trade the amount of Gil you specify in the Gil to Trade control to the player you have targeted. FFXIV limits the amount of Gil that can be transferred in a single trade to 1M, but MG will initiate multiple trades to trade amounts greater than 1M.  If you run MG on the recipient using Auto Trade mode (specified in the Settings Tab; by default, it is disabled), then the entire amount of Gil you requested to be traded will be transferred automatically. |
 ==== Auto Inventory Management Mode ====
@@ Line 58: / Line 59: @@
 {{:mistahmikey:materialgirl:auto_inventory_mangement.png?400|}}
-When Material Girl is in auto inventory management mode, as the status of your equipped items change, or as items appear in you inventory bags, the requested functions will be automatically applied.  You request which functions are applied via the following controls:
+When MG is in auto inventory management mode, as the status of your equipped items change, or as items appear in you inventory bags, the requested functions will be automatically applied.  You request which functions are applied via the following controls:
-| Auto Extract Materia | When clicked, Material Girl will automatically extract materia from your equipped items when they reach 100% spiritbond. Material Girl will show you how many materia were extracted in the Extracted Materia Count control. |
+| Auto Extract Materia | When clicked, MG will automatically extract materia from your equipped items when they reach 100% spiritbond. MG will show you how many materia were extracted in the Extracted Materia Count control. |
-| Auto Repair | When clicked, Material Girl will automatically repair your equipped items when they fall below the repair threshold (specified in the Settings Tab; by default, it is set to 50%.) For the repair to occur, you must have the required dark matter in your inventory bags. Material Girl will show you how many items were repaired in the Repaired Item Count control. |
+| Auto Repair | When clicked, MG will automatically repair your equipped items when they fall below the repair threshold (specified in the Settings Tab; by default, it is set to 50%.) For the repair to occur, you must have the required dark matter in your inventory bags. MG will show you how many items were repaired in the Repaired Item Count control. |
-| Auto Desynthesize | When clicked, Material Girl will automatically desynthesize items in your inventory bags. You can limit the items that will be desynthesized using the Filter Expression.  Material Girl will show you how many items were desynthesized in the Desynthesized Item Count control. |
+| Auto Desynthesize | When clicked, MG will automatically desynthesize items in your inventory bags. You can limit the items that will be desynthesized using the Filter Expression.  MG will show you how many items were desynthesized in the Desynthesized Item Count control. |
-| Filter Expression | By entering a filter expression, you can limit the items Material Girl will select from your inventory bags to be desynthesized  (explained in the Filter Expression section). The filter expression you enter must start with the "desynth" primitive expression or it will be rejected. |
+| Filter Expression | By entering a filter expression, you can limit the items MG will select from your inventory bags to be desynthesized  (explained in the Filter Expression section). The filter expression you enter must start with the "desynth" primitive expression or it will be rejected. |
 __**NOTE**__
-The way the automatic inventory management feature works is, as Material Girl detects items to which the requested functions can be applied, it will force your character to stop moving for an instant so that they can be applied.  For example, if you are running a dungeon using some other addon, and you are also running Material Girl in automatic inventory management mode, it will "fight" the other addon's attempts to automatically move your character until it successfully completes the requested functions.  As a result, you might see some "Event Cancelled" messages appear in the chat log, which means the other addon "won", and your character moved during the requested function, causing it to abort.  This rarely happens, and when it does, it typically only happens once.
+The way the automatic inventory management feature works is, as MG detects items to which the requested functions can be applied, it will force your character to stop moving for an instant so that they can be applied.  For example, if you are running a dungeon using some other addon, and you are also running MG in automatic inventory management mode, it will "fight" the other addon's attempts to automatically move your character until it successfully completes the requested functions.  As a result, you might see some "Event Cancelled" messages appear in the chat log, which means the other addon "won", and your character moved during the requested function, causing it to abort.  This rarely happens, and when it does, it typically only happens once.
-Using your Profile (explained in the Profile Tab section), you can save the state of the Enable, Auto Inventory Management, Auto Item Function, and Filter Expression controls so that when Material Girl is loaded (at game launch, or if you use Minion's Reload LUA feature), Material Grill will start up in the saved state.  This can be helpful when you are, say, using Husbando's Max's Dungeon Master to repeatedly run some trust and you lose connection, causing the game to exit and Minion to subsequently auto restart the game. When the game restarts, it will pick up right where it left off.
+Using your Profile (explained in the Profile Tab section), you can save the state of the Enable, Auto Inventory Management, Auto Item Function, and Filter Expression controls so that when MG is loaded (at game launch, or if you use Minion's Reload LUA feature), Material Grill will start up in the saved state.  This can be helpful when you are, say, using Husbando's Max's Dungeon Master to repeatedly run some trust and you lose connection, causing the game to exit and Minion to subsequently auto restart the game. When the game restarts, it will pick up right where it left off.
-**If you are not careful, using the auto desynthesize function can cause you to unintentionally lose valuable items.**  This is especially true if you use your Profile to enable automatic inventory management and Auto Desynthesize when Material Girl is loaded. To offer some degree of protection, Material Girl will detect when you start crafting, and will automatically disable automatic desynthesize mode in that situation unless you have explicitly disabled that behavior in the settings.  However, if you were to buy a piece of equipment, and Auto Desynthesize is enabled, Material Girl will dutifully desynthesize it as soon as it appears in your inventory.  **Unless you specifically limit what is automatically selected for desynthesis via a filter expression, every desythesizable item in your inventory bag will automatically be desythesized as soon as you enable this function.** So pay attention.
+**If you are not careful, using the auto desynthesize function can cause you to unintentionally lose valuable items.**  This is especially true if you use your Profile to enable automatic inventory management and Auto Desynthesize when MG is loaded. To offer some degree of protection, MG will detect when you start crafting, and will automatically disable automatic desynthesize mode in that situation unless you have explicitly disabled that behavior in the settings.  However, if you were to buy a piece of equipment, and Auto Desynthesize is enabled, MG will dutifully desynthesize it as soon as it appears in your inventory.  **Unless you specifically limit what is automatically selected for desynthesis via a filter expression, every desythesizable item in your inventory bag will automatically be desythesized as soon as you enable this function.** So pay attention.
 ==== Manual Inventory Management ====
-The main purpose of Material Girl is to help you select and manage items from the various inventories FFXIV provides you.  There is quite a wide array of features provided for that purpose.
+The main purpose of MG is to help you select and manage items from the various inventories FFXIV provides you.  There is quite a wide array of features provided for that purpose.
 When Manual Inventory Management mode is selected (which means Auto Inventory Management was not selected), there are two information lines that appear.
-| Selected Inventory Types | Using the Inventory Types tab, you can select the specific inventories from which Material Girl will retrieve items. The inventories you have currently selected are listed here. |
+| Selected Inventory Types | Using the Inventory Types tab, you can select the specific inventories from which MG will retrieve items. The inventories you have currently selected are listed here. |
-| Selected Gearsets | Using the Gearsets tab, you can select the specific FFXIV gearset that Material Girl will use for the Sync Gearsets function.  The gearsets you have currently selected are listed here. |
+| Selected Gearsets | Using the Gearsets tab, you can select the specific FFXIV gearset that MG will use for the Sync Gearsets function.  The gearsets you have currently selected are listed here. |
-| Filter Expression | By entering a filter expression, you can limit the items Material Girl will select to be displayed (explained in the Filter Expression section.)  If no filter expression is provided, Material Girl will select all items in your Selected Inventory Types. |
+| Filter Expression | By entering a filter expression, you can limit the items MG will select to be displayed (explained in the Filter Expression section.)  If no filter expression is provided, MG will select all items in your Selected Inventory Types. |
 ==== Filter Expression ====
-A filter expression can be used to limit the items on which Material Girl will perform functions.  It uses a simple, but powerful, boolean selection language that supports selecting items at a very fine level of detail.
+A filter expression can be used to limit the items on which MG will perform functions.  It uses a simple, but powerful, Boolean selection language that supports selecting items at a very fine level of detail.
 The filter expression is entered into the text input control just below the Filter Expression label.  You type in the expression and hit return, at which time the expression is parsed. You will see a message indicating either success or failure.  The failure message will give you information that pinpoints where in the expression the parse failed. If the expression is parsed successfully, it is immediately applied to the operation at hand.
@@ Line 108: / Line 109: @@
 	( <expression> )
-<primitiveExpression> := #these all evaluate to TRUE or FALSE for a inventory item
+<primitiveExpression> := #these all evaluate to TRUE or FALSE for a bag item
 	<patternOp> | #item name matches lua pattern
 	<nameOp> | #item name exactly matches string
@@ Line 114: / Line 115: @@
 	<classOp> | #item class matches class mnemonic
 	<jobClassOp> | #item class matches job class mnemonic
-	<categoryOp> | #item clas matches item ui category mnueumonic
+	<categoryOp> | #item class matches item ui category mnemonic
 	desynth | #item can be desynthed
 	hq | #item is high quality
@@ Line 121: / Line 122: @@
 	sellable | #item is sellable
 	collectable | #item is collectable
-	<relationOp> #item satifies a relation
+	buyable | #item can be bought at a vendor
+	<relationOp> #item satisfies a relation
 <unaryBooleanExpression> :=
@@ Line 141: / Line 143: @@
 <idOp> := <number> # item id
-<classOp> := #item class name
+<classOp> :=
+	c_weapon |
+	c_arcana |
+	c_shield |
+	c_armor |
+	c_food |
+	c_enhancement |
+	c_enfeeblement |
+	c_potion |
+	c_ether |
+	c_elixir |
+	c_crystal |
+	c_material |
+	c_materia |
+	c_furnishing |
+	c_dye |
+	c_misc |
+	c_bait |
+	c_treasureMap |
+	c_misc1 |
+	c_seed |
+	c_soil |
+	c_pomace |
+	c_masterCraftBook |
+	c_aetherialWheel |
+	c_primedAetherialWheel |
+	c_tripleTriadCard |
+	c_airshipPart |
+	c_currency |
+	c_folkloreBook |
+	c_soulCrystal |
+	c_orchestrationRoll |
+	c_tankTrimming |
+	c_painting |
+	c_retainerTalesOfAdventure |
+	c_submersiblePart |
+	c_logosAction |
+	c_mettle |
+	c_lostAction |
+	c_bozjanCluster |
+	c_unknown |
+	c_unobtainable |
+	c_reward |
+	c_cowrie |
+	c_sanctuaryIslandMaterial |
+	c_adventurersparcel |
+	c_outfit
 <jobClassOp> :=
 	#item job name |
@@ Line 157: / Line 205: @@
 	secondarytool | #matches ui category that is a secondary tool
 	tool | #matches ui category that is a primary or secondary tool
-	arm  | #matches ui category that is an arm
+	battlearm  | #matches ui category that is an arm used in battle
-	equipment #matches ui category that is a an equippable piece of equipment
+	equipment | #matches ui category that is a an equippable piece of equipment
+        material # matches any kind of material you would typically get via gathering
 <relationOp> :=
@@ Line 194: / Line 243: @@
 	not |
 	!
 </code>
@@ Line 220: / Line 268: @@
 The item list table provide a wide range of item attributes for you to view.  Note that the column headers provide buttons that allow you to sort the list according to values in that column: “^” sorts in the ascending direction (lowest to highest values), while “v” sorts in the descending direction (highest to lowest values). The item information displayed in each column is:
-| Name           | The item's name                                                |
+| Name           | The item's name                                                                                                                                                                 |
-| Inv Type       | The inventory type of the inventory in which the item resides  |
+| Inv Type       | The inventory type of the inventory in which the item resides                                                                                                                   |
-| Slot           | The slot within the inventory that holds the item              |
+| Slot           | The slot within the inventory that holds the item                                                                                                                               |
-| Level          | The player level of the item                                   |
+| Level          | The player level of the item                                                                                                                                                    |
-| iLevel         | The item level of the item                                     |
+| iLevel         | The item level of the item                                                                                                                                                      |
-| HQ Count       | The number of this item that are high quality                  |
+| HQ Count       | The number of this item that are high quality                                                                                                                                   |
-| NQ Count       | The number of this item that are normal quality                |
+| NQ Count       | The number of this item that are normal quality                                                                                                                                 |
-| Can Desynth    | The item can be desynthesized                                  |
+| Can Desynth    | The item can be desynthesized                                                                                                                                                   |
-| Materia Count  | The number of materias attached to the item                    |
+| Materia Count  | The number of materias attached to the item                                                                                                                                     |
-| % SB           | The item's spiritbond percentage                               |
+| % SB           | The item's spiritbond percentage                                                                                                                                                |
-| % Cond         | The item's damage condition                                    |
+| % Cond         | The item's damage condition                                                                                                                                                     |
-| Col Rtg        | The item's collectability rating                               |
+| Col Rtg        | The item's collectability rating                                                                                                                                                |
-| Can Trade      | The item can be traded                                         |
+| Can Trade      | The item can be traded                                                                                                                                                          |
-| Vendor Price   | The gil amount a vendor will pay for the item                  |
+| Can Buy        | The item can be bought at a vendor. If you double right click on a cell in this column containing a "true" value, a popup table of the vendors who sell this item is displayed.  |
+| Vendor Price   | The gil amount a vendor will pay for the item                                                                                                                                   |
-Depending on the inventory types of the individual items you've selected, certain functions may not be applicable. For example, you can't sell items out of your saddle bags, so if you attempt to do so, Material Girl will deny the request.  Material Girl also prohibits you from preforming destructive operations on your equipment inventory types, and requires you to first move them from your equipped items or armory into your inventory bags to do things like retrieve materia, desynthesize, or discard. When functions are disallowed, Material Girl will provide a popup that identifies the disallowed functions.
+Depending on the inventory types of the individual items you've selected, certain functions may not be applicable. For example, you can't sell items out of your saddle bags, so if you attempt to do so, MG will deny the request.  MG also prohibits you from preforming destructive operations on your equipment inventory types, and requires you to first move them from your equipped items or armory into your inventory bags to do things like retrieve materia, desynthesize, or discard. When functions are disallowed, MG will provide a popup that identifies the disallowed functions.
 The functions you can perform are:
-| Extract Materia     | If the enabled item has fully spiritbonded materia, it is extracted.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| Save                | Save the currently selected item list table to a CSV file.  The created CSV file, which will have an automatically generated unique filename, is located in the following directory: <MINIONAPP installation directory>\Bots\FFXIVMinion64\LuaMods\MaterialGirl\CSVs.|
-| Repair Selected     | If the enabled item is in need of repair (it's condition is below the threshold specified in the Settings tab), and you have the required dark matter in your inventory, it is repaired.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+| Extract Materia     | If the selected item has fully spiritbonded materia, it is extracted. |
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| Retrieve Materia    | If the selected item has materia, they all are retrieved. This is considered to be a destructive function, so you will be prompted to authorize it. |
-| Repair All          | Material Girl will Navigate your character to Alistair in Limsa Lominsa Lower Decks (future Material Girl versions may support mendor selection or traveling to the nearest mender.)  For each selected inventory, Material Girl will interact with the Mender to repair all items in that inventory.  Specifically, the enabled state of items in the list is ignored.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| Repair Selected     | If the selected item is in need of repair (it's condition is below the threshold specified in the Settings tab), and you have the required dark matter in your inventory, it is repaired.|
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| Repair All          | MG will Navigate your character to Alistair in Limsa Lominsa Lower Decks (future MG versions may support mendor selection or traveling to the nearest mender.)  For each selected inventory, MG will interact with the Mender to repair all items in that inventory.  Specifically, the selected state of items in the list is ignored.|
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| Use                 | if the selected item can be used, it is used. If the item is stacked, all items in the stack are used. This is considered to be a destructive function, so you will be prompted to authorize it.|
-| Use                 | if the enabled item can be used, it is used. If the item is stacked, all items in the stack are used. This is considered to be a destructive function, so you will be prompted to authorize it.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| Desynthesize        | If the selected item is desynthesizable, it is desynthesized. If the item is stacked, all items in the stack are used. This is considered to be a destructive function, so you will be prompted to authorize it.|
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| Discard             | The selected item is discarded. If the item is stacked, all items in the stack are discarded. This is considered to be a destructive function, so you will be prompted to authorize it.|
-| Retrieve Materia    | If the enabled item has materia, they all are retrieved. This is considered to be a destructive function, so you will be prompted to authorize it.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+| Lower Quality       | If the selected item is HQ, it's quality is lowered to NQ. If the item is stacked, the quality of all items in the stack is lowered. This is considered to be a destructive function, so you will be prompted to authorize it.|
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| Merge               | Merges the selected stackable items into larger stacks. You can select just the items you want stacked, or you can select everything an MG will merge everything that is stackable. |
-| Desynthesize        | If the enabled item is desynthesizable, it is desynthesized. If the item is stacked, all items in the stack are used. This is considered to be a destructive function, so you will be prompted to authorize it.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| Expert Delivery     | The selected item will be offered up for expert delivery.  MG will navigate your character to the appropriate Grand Company officer and interact with it to deliver all enabled items.  By default, special items will not be delivered, but this can be enabled using the Settings tab. If delivering an item will put you over your maximum company seal allowance, the function will be terminated. While this could be considered to be a destructive function, you will be not be prompted to authorize it, since you have plenty of time to abort while it is traveling to the NPC required to accomplish it.|
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| Trade Items         | The selected item will be offered for trade to the character you are targeting.  If that player is also running MG with Auto Trade enabled (specified bin the Settings tab; by default, it is disabled), then all enabled items requested will be automatically traded using multiple trade sessions. This is very useful for trading items between your main and alt characters. Sell - the enabled item will be offered for sale to Genulf in Limsa Lominsa Lower Decks (future MG versions may support vendor selection or traveling to the nearest vendor.)  By default, special items will not be sold, but this can be enabled using the Settings tab. MG will navigate your character to Genulf and sell all the enabled items to him. While this could be considered to be a destructive function, you will be not be prompted to authorize it, since you have plenty of time to abort while it is traveling to the NPC required to accomplish it.  |
-| Discard             | The enabled item is discarded. If the item is stacked, all items in the stack are discarded. This is considered to be a destructive function, so you will be prompted to authorize it.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+| Sell                | The selected items will be sold to a vendor that is specified in the Setting tab (see description there for more information.) By default, special items will not be sold, but this can be enabled using the Settings tab. MG will navigate your character the appropriate vendor and sell all the selected items to it. Please note the entire stack of the item you select will be sold; if you want to sell fewer items you must first use the FFXIV Split feature to create the smaller stack you wish to sell. While this could be considered to be a destructive function, you will be not be prompted to authorize it, since you have plenty of time to abort while it is traveling to the NPC required to accomplish it.|
-| Merge               | Merges the selected stackable items into larger stacks. You can select just the items you want stacked, or you can select everything an Material Girl will merge everything that is stackable. |
+| Select Destination  | The selected items will be moved to the inventory you select from the dropdown list. Some of the inventory selections will be groups, like Armory, while others will be specific inventories, like Bag 1. In all cases, the item is moved into the first available slot in the selected inventory. |
-| Expert Delivery     | The enabled item will be offered up for expert delivery.  Material Girl will navigate your character to the appropriate Grand Company officer and interact with it to deliver all enabled items.  By default, special items will not be delivered, but this can be enabled using the Settings tab. If delivering an item will put you over your maximum company seal allowance, the function will be terminated. While this could be considered to be a destructive function, you will be not be prompted to authorize it, since you have plenty of time to abort while it is traveling to the NPC required to accomplish it.                                                                                                                                                                                                                                                                                                                                                               |
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| Trade Items         | The enabled item will be offered for trade to the character you are targeting.  If that player is also running Material Girl with Auto Trade enabled (specified bin the Settings tab; by default, it is disabled), then all enabled items requested will be automatically traded using multiple trade sessions. This is very useful for trading items between your main and alt characters. Sell - the enabled item will be offered for sale to Genulf in Limsa Lominsa Lower Decks (future Material Girl versions may support vendor selection or traveling to the nearest vendor.)  By default, special items will not be sold, but this can be enabled using the Settings tab. Material Girl will navigate your character to Genulf and sell all the enabled items to him. While this could be considered to be a destructive function, you will be not be prompted to authorize it, since you have plenty of time to abort while it is traveling to the NPC required to accomplish it.  |
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| :::                 | :::                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| Sell                | The enabled item will be offered for sale to Genulf in Limsa Lominsa Lower Decks (future Material Girl versions may support vendor selection or traveling to the nearest vendor.) By default, special items will not be sold, but this can be enabled using the Settings tab. Material Girl will navigate your character to Genulf and sell all the enabled items to him. While this could be considered to be a destructive function, you will be not be prompted to authorize it, since you have plenty of time to abort while it is traveling to the NPC required to accomplish it.                                                                                                                                                                                                                                                                                                                                                                                               |
-| Select Destination  | The enabled items will be moved to the inventory you select from the dropdown list. Some of the inventory selections will be groups, like Armory, while others will be specific inventories, like Bag 1. In all cases, the item is moved into the first available slot in the selected inventory. |
+=== Vendors Table ===
+If you double right click on a cell in the "Can Buy" column with a "true" value, a popup window will display a table of the vendors who sell the item.
+{{:mistahmikey:materialgirl:vendors_table.png?400|}}
+If you also own Taximan, you can double right click on any vendor in the table to add it to your favorites.  It is always added to your current default category. If Taximan is running, the addition is immediately live - that is, you don't have to reload Taximan for it to pick up the change to your favorites.  Please be aware, some of the vendors may be at locations Taximan cannot reach, because they are behind some intermediate obstacle that it is not programmed to get by.  If someone has a burning need to go to such a vendor, please contact me via Discord and I'll see if it is possible to add the required intermediary to MistahMikeysLib.
@@ Line 280: / Line 321: @@
 {{:mistahmikey:materialgirl:inventory_types_tab.png?400|}}
-The Inventory Types Tab allows you to to select the inventory types from which Material Girl will select items.
+The Inventory Types Tab allows you to to select the inventory types from which MG will select items.
 You can select individual inventory type entries by either clicking the check box to the left of it or by mousing over the inventory type name and clicking on it.  You can toggle between all inventory type entries being selected or not by toggling the check box under the Selection label.
-For the saddlebag inventory types to appear, Material Girl must be able to operate the saddlebag main command.  This requires a cast, so if your action bar is disabled (doesn't appear on your screen) then the saddlebag types will not appear.  This typically occurs because you have FFXIV windows open that causes the action bar to be disabled.  If this happens, just close all your open FFXIV windows, then hit the Reset button on the Material Girl UI.
+For the saddlebag inventory types to appear, MG must be able to operate the saddlebag main command.  This requires a cast, so if your action bar is disabled (doesn't appear on your screen) then the saddlebag types will not appear.  This typically occurs because you have FFXIV windows open that causes the action bar to be disabled.  If this happens, just close all your open FFXIV windows, then hit the Reset button on the MG UI.
-The retainer bag inventory types are only available while you have the retainer inventory window open. So you must manually open the retainer inventory window to enable using Material Girl on retainer bags.
+The retainer bag inventory types are only available while you have the retainer inventory window open by using the "Entry or withdraw items" menu item.
+The company chest bag inventory types are only available while you have the company chest window open.  You must also click on the individual bags once this window is open to populate them.
 The selected inventory types will be displayed on the Main Tab next to the Selected Inventory Types label.
+You can also select groups of bags by using the convenience buttons at the top of the inventory type list.  When you click one of the convenience buttons, it will toggle the state of all associated bags to be the opposite of the first button in the group.
+| Bags                | Toggles all four of your inventory bags.                                                          |
+| Armory Bags         | Toggles all of the armory slot bags.                                                              |
+| Saddlebags          | Toggles all two or four (if you have the FFXI Companion Premium service) of your inventory bags.  |
+| Retainer Bags       | Toggles all seven of your retainer bags.                                                          |
+| Company Chest Bags  | Toggles all five of your company chest bags.                                                      |
 ===== Gearsets Tab =====
 {{:mistahmikey:materialgirl:gearsets_tab.png?400|}}
@@ Line 313: / Line 364: @@
 {{:mistahmikey:materialgirl:settings_tab.png?400|}}
-The Settings Tab allows you to modify the settings that affect various aspects of Material Girl's operation.
+The Settings Tab allows you to modify the settings that affect various aspects of MG's operation.
-| Auto Handover | When checked, Material Girl will monitor for certain controls that require you to hand over items and automatically hand over the ones being requested.  This does not currently work for all such possible controls, and was mainly created to assist in acquiring some of the early crafting masters books. As people use Material Girl, if there are controls that can benefit from this feature, I urge them to use the Material Girl discord channel to request their addition. |
+| Auto Handover | When checked, MG will monitor for certain controls that require you to hand over items and automatically hand over the ones being requested.  This does not currently work for all such possible controls, and was mainly created to assist in acquiring some of the early crafting masters books. As people use MG, if there are controls that can benefit from this feature, I urge them to use the MG discord channel to request their addition. |
-| Auto Trade | When checked, Material Girl will automatically handle receiving trades. This is intended to be used with another character that is using Material Girl to trade items from its inventory bags to the recipient character. |
+| Auto Trade | When checked, MG will automatically handle receiving trades. This is intended to be used with another character that is using MG to trade items from its inventory bags to the recipient character. |
-| Accept Sale of Special Item | When checked, Material Girl will automatically allow special items to be sold. |
+| Accept Sale of Special Item | When checked, MG will automatically allow special items to be sold. |
-| Accept Delivery of Special Item | When checked, Material Girl will automatically allow expert delivery of special items. |
+| Accept Delivery of Special Item | When checked, MG will automatically allow expert delivery of special items. |
-| Set Recommended Gear During Armory Clean | When checked, Material Girl will first set recommended gear for each selected gearset before cataloging the equipment being used from that gearset. |
+| Set Recommended Gear During Armory Clean | When checked, MG will first set recommended gear for each selected gearset before cataloging the equipment being used from that gearset. |
-| Override Automatic Desynthesize Mode Disable | When checked, Material Girl will allow you to automatically desynthesize items as you craft. This is useful for leveling desynthesis skill. If you use Lisbeth for crafting, be sure to disable its auto material extraction and repair features if you enable them in Material Girl. This setting is NOT saved to your profile. |
+| Override Automatic Desynthesize Mode Disable | When checked, MG will allow you to automatically desynthesize items as you craft. This is useful for leveling desynthesis skill. If you use Lisbeth for crafting, be sure to disable its auto material extraction and repair features if you enable them in MG. This setting is NOT saved to your profile. |
-| Override Equipped Gearset Materia Retrieval Block | When checked, Material Girl will allow you to retrieve materia from your equipped gear. This setting is NOT saved to your profile. |
+| Override Equipped Gearset Materia Retrieval Block | When checked, MG will allow you to retrieve materia from your equipped gear. This setting is NOT saved to your profile. |
 | Min Repair Condition | The equipment condition threshold for repairing equipment that falls below the set threshold. |
+| Preferred Vendor | This combo box is used to specify what vendor MG will use for the Sell function. If you have never selected a vendor and saved your settings, by default Gerulf is selected. If you select a preferred vendor and want this selection to persist, you must save your selection to your profile using the Profile tab. You can select whatever vendor you prefer from the combo box list. If you select None, then MG will automatically select a vendor as follows:  it will first try to find the closest vendor in the current zone, and if none exist, it will select a random vendor from those available. The available vendors are automatically extracted from the game data - however, this process is not foolproof, because that data contains information for obsolete vendors or vendors that you may not have access to because 1) you haven't completed prerequisite quests to enable them, 2) the special events they are associated with aren't currently in effect, or 3) you do not have access to the ares in which they reside. I have tried to eliminate the obsolete vendors, and the combo box list is based on vendors I am able to access, which is the vast majority of those available. As a result, you might not be able to access some of those vendors or you might be able to access vendors that are not in the list.  To handle the situation where you do not have access to vendor in the combo box list, you can use the vendor blacklist feature to prevent those vendors from being selected. If you need access to a vendor not included in the combo box list, then contact me via discord with the information about where the vendor resides and I will add it to the list. The information I need is the vendor's name, mapid, and x,y,z and heading coordinates.  The x,y,z and heading coordinates can be obtained by using Minion's built-in Dev Tools addon's Target option.  You simply target the vendor, open the Target option, and the information is under the Position option.  The mapid can be obtained by using the Minion Console by typing "d(Player.localmapid)" (without the quotes) into the input field.  Be aware that some zones might require me to add a new intermediary to my teleport function before you will be able to travel to it. This might not be possible for a variety of reasons, but I will do my best to add it if it is possible. |.
+| Move To Blacklisted Vendors | When clicked, the currently selected Preferred Vendor will be moved to the Blacklisted Vendors list.  The blacklisted vendors list is automatically saved when modified. |
+| Blacklisted Vendor | This combo box contains a list of currently blacklisted vendors.  If that list is empty, None is shown. |
+| Move To Preferred Vendors | When clicked, the currently selected blacklisted vendor is moved to the Preferred Vendors list.  The blacklisted vendors list is automatically saved when modified. |
 ===== Profile Tab =====
 {{:mistahmikey:materialgirl:profile_tab.png?400|}}
-The Profile Tab allows you to persistently store most of Material Girl's settings. The profile settings are stored in files unique to the character and game language used to create the profile. You can create as many profiles as you like. The controls on this tab are:
+The Profile Tab allows you to persistently store most of MG's settings. The profile settings are stored in files unique to the character and game language used to create the profile. You can create as many profiles as you like. The controls on this tab are:
-Load Current Profile After Reset:  When checked, if you hit Reset on the Main Tab, or when Material Girl is loaded when you start Minion, after all settings are initialized to their default values, the saved settings in your current profile are loaded.
+Load Current Profile After Reset:  When checked, if you hit Reset on the Main Tab, or when MG is loaded when you start Minion, after all settings are initialized to their default values, the saved settings in your current profile are loaded.
-| Current Profile Name | The settings file you selected to be the current profile being used by Material Girl. |
+| Current Profile Name | The settings file you selected to be the current profile being used by MG. |
 | Load | Load all settings from the current profile. |
 | Save | Save all settings to the current profile. |
@@ Line 343: / Line 398: @@
 {{:mistahmikey:materialgirl:debug_tab.png?400|}}
-This tab is primarily intended for use in conjunction with consultation with Material Girl support.  It enables various test scenarios and debugging information that are used to help diagnose issues that might occur during Squatter's operation.  The controls on this tab are:
+This tab is primarily intended for use in conjunction with consultation with MG support.  It enables various test scenarios and debugging information that are used to help diagnose issues that might occur during Squatter's operation.  The controls on this tab are:
-| Enable Log file | When checked, Material Girl will create a unique log file for your session. This only needs to be checked if you are told to do so by Squatter support. |
+| Enable Log file | When checked, MG will create a unique log file for your session. This only needs to be checked if you are told to do so by Squatter support. |
-| Enable Timestamp | When checked, Material Girl will include the current tick count in the debug messages. This provides information that facilitates debugging timing issues. |
+| Enable Timestamp | When checked, MG will include the current tick count in the debug messages. This provides information that facilitates debugging timing issues. |
-| Debug Message Level Settings | Material Girl's debug message system implements a simple filtering mechanism that can be used to allow or inhibit certain message classes, generally in increasing order of verbosity.  The default settings are fairly "quiet", but to debug issues you encounter you will be asked to enable more verbose settings to gather diagnostic information. |
+| Debug Message Level Settings | MG's debug message system implements a simple filtering mechanism that can be used to allow or inhibit certain message classes, generally in increasing order of verbosity.  The default settings are fairly "quiet", but to debug issues you encounter you will be asked to enable more verbose settings to gather diagnostic information. |
 ====== Support ======
-For support or requests, please contact me on discord: https://discord.gg/zy2jsfJMvv.  I will respond as soon as I am able, generally within 24 hours at most.
+For bug support, please post a message on discord: https://discord.gg/WeU3v62v.  I will respond as soon as I am able, generally within 24 hours at most.
 When you need support, please provide me, at a minimum, the following:
   - Enable the debug information category on the Debug Tab and do what you did to create the problem.  Then take a screen shot of your Minion Console Log when the problem occurs. Make sure the Log's window as big as possible to show the maximum amount of output.  If the output is larger than the window, then scroll the offscreen portions into view and send multiple screen shots.
-  - A screen shot of your Material Girl main tab
+  - A screen shot of your MG main tab
 If you post this information to the specified channel (NOT RECOMMENDED), **please ensure it does not contain any information that identifies your account, character, or server.**  For complete anonymity, just DM it to mistahmikey#4073.
 Additionally, **you should not use an account you use for in-game communications so you can't be doxed as a botter. **
-If that initial information is insufficient for me to determine the cause, I will ask you to set other debug settings that will provide more information. Material Girl is a very complex piece of software, and can be negatively affected by a number of factors over which I have no control, not the least of which is what other addons you run. I appreciate your patience in working with me to solve your issue when it is not slam-dunk easy. As long as you are willing to try the debugging measures I request, I will work with you until your problem is solved.
+If that initial information is insufficient for me to determine the cause, I will ask you to set other debug settings that will provide more information. MG is a very complex piece of software, and can be negatively affected by a number of factors over which I have no control, not the least of which is what other addons you run. I appreciate your patience in working with me to solve your issue when it is not slam-dunk easy. As long as you are willing to try the debugging measures I request, I will work with you until your problem is solved.

User Tools

Site Tools

Differences

Page Tools