This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| materialgirl [2026/01/10 18:03] – 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 ===== | ||
| - | 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. | + | 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): 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. | ||
| 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 |
| + | |||
| + | Item information uses MML' | ||
| MG supports the following languages: EN. | MG supports the following languages: EN. | ||
| Line 31: | Line 34: | ||
| MG 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 ====== | ||
| + | |||
| + | 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 " | You start MG via the FFXIVMinion menu drop down. It's under the " | ||
| Line 82: | Line 94: | ||
| | Selected Gearsets | Using the Gearsets tab, you can select the specific FFXIV gearset that MG 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 MG 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 ==== | ||
| 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 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 373: | Line 389: | ||
| | 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. | | | 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. | | | 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: | + | | 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: |
| | 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 MG' | + | The Display Language choice on Debug is saved with this addon' |
| - | Load Current | + | The Profile Tab allows |
| + | | 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. | | | 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. | | ||
| 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 MG support. | + | This tab is primarily intended for use in conjunction with consultation with 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. | | + | 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, MG will include the current tick count in the debug messages. This provides information that facilitates debugging timing issues. | | + | |
| - | | 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. | + | |
| - | ====== 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 MG 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. |