This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| materialgirl [2026/01/05 06:48] – [Settings Tab] mistahmikey | materialgirl [2026/11/18 01:27] (current) – Remove Release Summary section mistahmikey | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== Material Girl (MG) ====== | ||
| {{: | {{: | ||
| ===== What it does ===== | ===== What it does ===== | ||
| - | Provides | + | Material Girl (MG) provides |
| * 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, | * 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, | ||
| * Allows you to automatically handover required items during certain transactions with NPCs. | * Allows you to automatically handover required items during certain transactions with NPCs. | ||
| - | * Allows you to trade unlimited (as governed by the recipient' | + | * Allows you to trade unlimited (as governed by the recipient' |
| * Allows you to move multiple selected items between any of your bags. | * 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. | * 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. | * 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: | + | 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: |
| ===== Requirements ===== | ===== Requirements ===== | ||
| - | You must also download | + | Install the free MistahMikeysLib |
| - | Currently, Material Girl only supports English. | + | Item information uses MML's shared game-data cache. First use can take longer while the required data is prepared. |
| - | You must ensure FFXIV, Minion, and Material Girl are always updated to their latest versions. | + | MG supports the following languages: EN. |
| - | 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. | + | You must ensure FFXIV, Minion, and MG are always updated to their latest versions. |
| + | |||
| + | 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**__ | __**IMPORTANT**__ | ||
| - | Material Girl provides some powerful options to manage your inventories, | + | MG provides some powerful options to manage your inventories, |
| + | |||
| + | |||
| + | ===== Shared Travel and Reloads ===== | ||
| + | Approaching a vendor now uses MML's shared travel coordination. If another participating addon already owns travel, the new approach is rejected instead of interrupting that trip. Wait for the current trip to finish, or cancel it through the addon that started it, before retrying the vendor operation. This travel coordination does not coordinate inventory operations; continue to disable conflicting inventory automation as described above. | ||
| + | |||
| + | During a normal Lua reload or unload, MML cancels owned travel and waits for its movement and transport to settle before allowing the reload or unload to complete. An already-issued teleport or area transition may still finish during that cleanup. The next load does not resume the old trip. Saved profiles and addon data are retained; enabled settings or profile loading may start new addon work according to your existing settings. | ||
| + | This coordination applies only to participating addons. It cannot prevent unrelated addons from issuing their own movement. Avoid running conflicting movement automation at the same time. | ||
| ====== UI ====== | ====== UI ====== | ||
| - | You start Material Girl via the FFXIVMinion menu drop down. It's under the " | + | The descriptions reflect the current release. Some screenshots show earlier layouts or English labels; the text describes the current controls. |
| + | |||
| + | You start MG via the FFXIVMinion menu drop down. It's under the " | ||
| ===== Main Tab ===== | ===== Main Tab ===== | ||
| Line 46: | Line 58: | ||
| These controls activate features generally not related to manipulating specific items you select from your inventories. | These controls activate features generally not related to manipulating specific items you select from your inventories. | ||
| - | | Enable | When checked, enables | + | | Enable | When checked, enables |
| - | | Auto Inventory Management | When checked, | + | | Auto Inventory Management | When checked, |
| | 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. | | 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. | ||
| - | | Discord Icon | Takes you to the Material Girl Discord channel if you need support. | + | | Discord Icon | Takes you to the MG Discord channel if you need support. |
| - | | Sync Gearsets | When clicked, | + | | Sync Gearsets | When clicked, |
| - | | Clean Armory | When clicked, | + | | Clean Armory | When clicked, |
| - | | Trade Gil | When clicked, | + | | Trade Gil | When clicked, |
| ==== Auto Inventory Management Mode ==== | ==== Auto Inventory Management Mode ==== | ||
| Line 58: | Line 70: | ||
| {{: | {{: | ||
| - | 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. | + | 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. |
| - | | Auto Extract Materia | When clicked, | + | | Auto Extract Materia | When clicked, |
| - | | Auto Repair | When clicked, | + | | Auto Repair | When clicked, |
| - | | Auto Desynthesize | When clicked, | + | | Auto Desynthesize | When clicked, |
| - | | Filter Expression | By entering a filter expression, you can limit the items Material Girl will select from your inventory bags to be desynthesized | + | | Filter Expression | By entering a filter expression, you can limit the items MG will select from your inventory bags to be desynthesized |
| __**NOTE**__ | __**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. | + | 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. |
| - | 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' | + | 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' |
| - | **If you are not careful, using the auto desynthesize function can cause you to unintentionally lose valuable items.** | + | **If you are not careful, using the auto desynthesize function can cause you to unintentionally lose valuable items.** |
| ==== Manual Inventory Management ==== | ==== 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. | 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. | + | | Selected Gearsets | Using the Gearsets tab, you can select the specific FFXIV gearset that MG will use for the Sync Gearsets function. |
| - | | 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.) | + | | Filter Expression | By entering a filter expression, you can limit the items MG will select to be displayed (explained in the Filter Expression section.) |
| + | |||
| + | ==== Filter Preview and Parsing ==== | ||
| + | Use Preview to inspect a nonempty filter before applying an inventory action. The preview shows the parsed grouping and matching inventory stacks, including item name, bag, slot, and quantity. It lists up to 20 stacks and reports any additional matches. The preview is informational: | ||
| + | |||
| + | Manual previews use the selected inventory types. Automatic desynthesis previews use the normal inventory bags. Changing the expression or inventory selection marks the preview as stale; click Preview again. Inventory contents can change after a preview, so check the current selection before performing an action. | ||
| + | |||
| + | Boolean precedence is '' | ||
| + | |||
| + | Automatic desynthesis filters must require '' | ||
| ==== Filter Expression ==== | ==== Filter Expression ==== | ||
| - | A filter expression can be used to limit the items on which Material Girl will perform functions. | + | A filter expression can be used to limit the items on which MG will perform functions. |
| The filter expression is entered into the text input control just below the Filter Expression label. | The filter expression is entered into the text input control just below the Filter Expression label. | ||
| Line 96: | Line 117: | ||
| < | < | ||
| - | < | + | < |
| - | <basicExpression> | + | |
| - | < | + | |
| - | < | + | |
| - | < | + | < |
| + | |||
| + | < | ||
| + | |||
| + | < | ||
| + | |||
| + | < | ||
| < | < | ||
| - | <primiviteExpression> | + | <primitiveExpression> |
| - | + | ||
| < | < | ||
| ( < | ( < | ||
| Line 123: | Line 147: | ||
| buyable | #item can be bought at a vendor | buyable | #item can be bought at a vendor | ||
| < | < | ||
| - | |||
| - | < | ||
| - | < | ||
| - | |||
| - | < | ||
| - | < | ||
| <eol> := #end of line | <eol> := #end of line | ||
| Line 189: | Line 207: | ||
| c_adventurersparcel | | c_adventurersparcel | | ||
| c_outfit | c_outfit | ||
| - | + | ||
| - | < | + | < |
| - | #item job name | | + | #item job name | |
| myjob | myjob | ||
| - | < | + | < |
| - | < | + | < |
| < | < | ||
| < | < | ||
| - | < | + | < |
| primarytool | #matches ui category that is a primary tool | primarytool | #matches ui category that is a primary tool | ||
| secondarytool | #matches ui category that is a secondary tool | secondarytool | #matches ui category that is a secondary tool | ||
| Line 224: | Line 242: | ||
| <= | <= | ||
| - | < | + | < |
| - | < | + | < |
| - | mylevel | | + | mylevel | |
| equippedlevel | equippedlevel | ||
| - | < | + | < |
| - | < | + | < |
| equippedilevel | equippedilevel | ||
| - | <booleanBinaryOp> := | + | <andOp> := and | & |
| - | and | | + | |
| - | & | | + | |
| - | or | | + | |
| - | \| | + | |
| - | < | + | < |
| + | |||
| + | < | ||
| not | | not | | ||
| ! | ! | ||
| Line 250: | Line 266: | ||
| This is perhaps the most useful primitive provided by the expression language. You can specify a Lua pattern to be matched against item names - if the pattern matches, the item is selected. | This is perhaps the most useful primitive provided by the expression language. You can specify a Lua pattern to be matched against item names - if the pattern matches, the item is selected. | ||
| - | | + | |
| Example 2 - Item selection using an Exact Name Match | Example 2 - Item selection using an Exact Name Match | ||
| Line 283: | Line 299: | ||
| | Vendor Price | The gil amount a vendor will pay for the item | | | 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. | + | 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. |
| The functions you can perform are: | The functions you can perform are: | ||
| Line 291: | Line 307: | ||
| | Retrieve Materia | | Retrieve Materia | ||
| | Repair Selected | | Repair Selected | ||
| - | | Repair All | Material Girl will Navigate your character to Alistair in Limsa Lominsa Lower Decks (future | + | | Repair All | MG will Navigate your character to Alistair in Limsa Lominsa Lower Decks (future |
| | 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 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.| | ||
| | Desynthesize | | Desynthesize | ||
| | Discard | | Discard | ||
| | Lower Quality | | Lower Quality | ||
| - | | 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. | | + | | 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. | |
| - | | Expert Delivery | + | | Expert Delivery |
| - | | Trade Items | The selected item will be offered for trade to the character you are targeting. | + | | Trade Items | The selected item will be offered for trade to the character you are targeting. |
| - | | 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. Material Girl will navigate your character the appropriate vendor and sell all the selected items to it. 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 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.| |
| | Select Destination | | Select Destination | ||
| Line 309: | Line 325: | ||
| If you also own Taximan, you can double right click on any vendor in the table to add it to your favorites. | If you also own Taximan, you can double right click on any vendor in the table to add it to your favorites. | ||
| - | + | ||
| Line 320: | Line 336: | ||
| {{: | {{: | ||
| - | 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. | 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, | + | For the saddlebag inventory types to appear, |
| 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 retainer bag inventory types are only available while you have the retainer inventory window open by using the "Entry or withdraw items" menu item. | ||
| Line 363: | Line 379: | ||
| {{: | {{: | ||
| - | 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, | + | | Auto Handover | When checked, |
| - | | Auto Trade | When checked, | + | | Auto Trade | When checked, |
| - | | Accept Sale of Special Item | When checked, | + | | Accept Sale of Special Item | When checked, |
| - | | Accept Delivery of Special Item | When checked, | + | | Accept Delivery of Special Item | When checked, |
| - | | Set Recommended Gear During Armory Clean | When checked, | + | | Set Recommended Gear During Armory Clean | When checked, |
| - | | Override Automatic Desynthesize Mode Disable | When checked, | + | | Override Automatic Desynthesize Mode Disable | When checked, |
| - | | Override Equipped Gearset Materia Retrieval Block | When checked, | + | | Override Equipped Gearset Materia Retrieval Block | When checked, |
| | Min Repair Condition | The equipment condition threshold for repairing equipment that falls below the set threshold. | | | Min Repair Condition | The equipment condition threshold for repairing equipment that falls below the set threshold. | | ||
| - | | Preferred Vendor | This 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 want this change | + | | 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 |
| | 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. | | | 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. | | Blacklisted Vendor | This combo box contains a list of currently blacklisted vendors. | ||
| Line 380: | Line 396: | ||
| {{: | {{: | ||
| - | The Profile Tab allows you to persistently store most of Material Girl' | + | The Display Language choice on Debug is saved with this addon' |
| - | Load Current | + | The Profile Tab allows |
| - | | Current Profile Name | The settings file you selected to be the current profile being used by Material Girl. | | + | | 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 MG. | | ||
| | Load | Load all settings from the current profile. | | | Load | Load all settings from the current profile. | | ||
| | Save | Save all settings to the current profile. | | | Save | Save all settings to the current profile. | | ||
| Line 390: | Line 407: | ||
| | Add | Create the new profile and save all current settings to it. | | | Add | Create the new profile and save all current settings to it. | | ||
| - | The table is a list of all the profiles you have created for the current character and game language. Using the " | + | The table is a list of all the profiles you have created for the current character and game region. Using the " |
| ===== Debug Tab ===== | ===== Debug Tab ===== | ||
| - | |||
| {{: | {{: | ||
| - | This tab is primarily intended for use in conjunction with consultation with Material Girl support. | + | This tab is primarily intended for use in conjunction with consultation with support. |
| - | | 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. | | + | Changing Display Language refreshes presentation without resetting active work. It does not change game text, interaction matching, command destination names, or region-based profile selection. Some screenshots show earlier controls |
| - | | Enable Timestamp | When checked, Material Girl 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. | + | |
| - | ====== Support ====== | + | |
| - | For bug support, please post a message on discord: https:// | + | | Display Language | Choose Automatic (Game Language), English, French, Japanese, Chinese (Simplified), |
| + | | Enable Log File | When checked, a unique log file will be created for your session. This only needs to be checked if you are told to do so by support. | | ||
| + | | Enable Timestamp | When checked, the current tick count will be included in the debug messages. This provides information that facilitates debugging timing issues. | | ||
| + | | Debug Message Level Settings | The 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. When checked, the corresponding message class is enabled. | | ||
| + | | Enable Async Logging | When checked, log output for periodic writing is buffered. | | ||
| + | | Log Flush Interval (ms) | Shown when async logging is enabled; sets the buffer flush interval in milliseconds. | | ||
| + | | Cleanup Log Files | When clicked, runs the library' | ||
| + | |||
| + | Additional tracing and diagnostic panels may appear when authorized by the library. Use these with support guidance. | ||
| + | |||
| + | ====== Support ====== | ||
| + | For bug support, please post a message on discord: https:// | ||
| When you need support, please provide me, at a minimum, the following: | 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. | - Enable the debug information category on the Debug Tab and do what you did to create the problem. | ||
| - | - A screen shot of your Material Girl main tab | + | - A screenshot |
| If you post this information to the specified channel (NOT RECOMMENDED), | If you post this information to the specified channel (NOT RECOMMENDED), | ||
| Additionally, | Additionally, | ||
| - | 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. | + | 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. |