Differences

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

--- islandsanctuaryhelper [2022/09/23 15:01] – [Material Orders Tab] mistahmikey
+++ islandsanctuaryhelper [2022/09/26 16:01] (current) – removed mushroom
@@ Line 1: / Line 1: @@
-====== Island Sanctuary Helper (ISH) ======
-{{:mistahmikey:islandsanctuaryhelper:islandsanctuary.png?400|}}
-===== What it does =====
-Provides tools to help you live your life on Noname Island more comfortably. This is intended to be a growing suite of such tools.  This, the initial offering, focuses on gathering. It enables you to create persistent material orders that ISH will automatically fill for you.  It will travel to all the required nodes, collect the requested materials, and return to home base when done.
-===== Requirements =====
-You must also download MistahMikeysLib from the store. It's free, of course.
-Currently, ISH only supports FFXIV 6.x, and only in English.
-You must ensure FFXIV, Minion, and ISH are always updated to their latest versions.
-====== UI ======
-You start ISH via the FFXIVMinion menu drop down. It's under the "MistahMikey" menu item.  Clicking "IslandSanctuaryHelper" 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 =====
-{{:mistahmikey:islandsanctuaryhelper:main_tab.png?400|}}
-This tab generally controls activation of the various ISH help tools provided.  It provides a progress summary of whatever tool is currently running.
-==== Top Level Controls ====
-Enable: When checked, enables you to run ISH tools.
-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).
-===== Material Orders Tab =====
-{{:mistahmikey:islandsanctuaryhelper:material_orders_tab.png?400|}}
-The Material Orders Tab allows you to create, save, and run lists of materials to be gathered.  You can create multiple lists as you please, and select any number of them to be run. The controls on this tab work as follows:
-| New | Allows you to create a new material order.  Prompts you for a unique name for the material order.  The name can contain any characters that are legal for a file name. |
-| Rename |Allows you to rename an existing material order. |
-| Delete | Allows you to delete all selected material orders. |
-| Edit | Allows you to edit an existing material order. |
-| Run | Allows you to run all selected material orders.  This will cause your player to gather the requested materials. |
-When you execute the New or Edit functions, the Material Order Edit page is presented.
-{{:mistahmikey:islandsanctuaryhelper:material_order_edit.png?400|}}
-This page allows you to construct the list of materials that comprise a material order.  You can add new materials, or edit existing ones, by using the entry controls above the material order table. To add a material to the material order table, you select the desired material from the drop-down list, enter a quantity (you must hit <return> for it to be registered), and then clicking "Add". If you select an material that already exists in the list, the new quantity will be added to the existing quantity.
-The list of materials comprising the material order appears in the table. The controls for this table work as follows:
-|Edit | Removes the selected material from the material order, and sets the the values that material had into the entry controls. You then use the entry controls as usual to modify it as you please and add it back. |
-| Delete | Deletes all selected materials from the material order. |
-| Save | Persistently saves changes to the material order |
-| Exit | Returns to the Material Orders page. If you have modified the material order but failed to save it, you will be given an opportunity to save it before actually exiting. |
-===== Settings Tab =====
-{{:mistahmikey:materialgirl:settings_tab.png?400|}}
-The Settings Tab allows you to modify the settings that affect various aspects of Material Girl'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 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.
-Accept Sale of Special Item - when checked, Material Girl 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.
-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.
-Automatic Desynthesize Mode Disable Override - 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.
-Min Repair Condition - the equipment condition threshold for repairing equipment that falls below the set threshold.
-===== 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:
-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.
-Current Profile Name:  The settings file you selected to be the current profile being used by Material Girl.
-Load: Load all settings from the current profile.
-Save: Save all settings to the current profile.
-Add New Profile:  The name of a new profile you wish to add (must be a valid file name).
-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 "Selection" column, you can select specific profiles for the operations Delete or Make Current.  Obviously, only one profile at a time can be made current, so you can only select one for that operation, but you can select as many as you like for the Delete operation.  You can select/deselect all profiles by using the checkbox in the operation row.
-===== Debug Tab =====
-{{: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:
-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 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.  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.
-When you need support, please provide me, at a minimum, the following:
-  - A screen shot of your Minion Console Log when the problem occurs
-  - A screen shot of your Material Girl main tab
-If you post this information to the specified channel, **please ensure it does not contain any information that identifies your account, character, or server.**  For complete anonymity, just DM it to mistahmikey#4073.
-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.

User Tools

Site Tools

Differences

Page Tools