island_sanctuary_helper [MMOMinion Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Island Sanctuary Helper (ISH) ======
{{:mistahmikey:islandsanctuaryhelper:islandsanctuary.png?400|}}

===== What it does =====

Provides tools to help you live your life on Unnamed Island more comfortably. The current offering supports gathering materials, capturing animals, managing crops, managing the pasture, level grinding, and creating workshop agendas.

== Material Gathering Support ==

ISH helps you to gather materials from the nodes distributed throughout the island.  You do so by creating "material orders", which are simply lists of materials along with the quantities you wish to have gathered. ISH will move your character to the required nodes, interact with them, and keep track of your progress fulfilling your material orders. You can use this feature to help with crafting or building quests, or you can use it to level your island.

You can also direct ISH to automatically export the materials you gather for Islander's Cowries that exceed a specified threshold.  When all the materials in a material order exceed a specified amount over a specified threshold, ISH will run to the Enterprising Exporter, initiate a sale for the specified amount of material over the specified threshold, and then will return to gathering.

== Animal Capture Support ==

ISH helps you fill your pasture with animals by capturing any animal you desire that roams the island.  You do so by creating "capture orders" (conceptually identical to "material orders".)  ISH will travel to the areas where the animals you specify live, track them down, equip the required restraint, sneak up behind them, and capture them for you.  This includes rare animals - ISH will prioritize capturing rare animals when their spawn conditions become current.  Your capture order can contain a mixture of basic and rare animals, and ISH will capture the basic ones whenever a rare one cannot be captured, immediately diverting to a rare capture when the time and weather conditions they require become current.  ISH recognizes when animals evade, and will automatically retry the capture until either it is successful or the animal gets spooked and runs away.

== Crop Management Support ==

ISH helps you reap, sow, and water your farmland plots.  For each plot, you can specify what seed will be planted. Once you have your crop plan created, all you have to do is run it, and ISH will automatically handle the rest (dependent on your IS level) by first traveling to each plot and reaping any ripened crop there, then traveling to each empty plot and sowing the seed you specified in your crop plan, then finally traveling to each plot that needs watering to water it.  If you have the privilege to buy seeds, ISH will automatically determine what additional seeds you need to satisfy you plant your crop plan and will purchase or gather them for you as needed.

== Pasture Management Support ==

ISH helps you feed and gather from the animals in your pasture. ISH will visit each animal, either select specific feed you request or automatically determine the best feed to elevate the animal's mood, feed the animal, then gather items from the animal if it has leavings.

== Level Grind Support ==

ISH helps you endlessly grind away at those little 10 exp gather nodes by exclusively focusing on gathering from a small area, so node visits are fast and efficient.  There are currently two grind areas - a pre level 10 area that requires no tools, and a level 10+ area on the mountain top that is a very tight gathering area. As you amass materials, you can have ISH automatically export them when they exceed a specified threshold and amount over that threshold - so not only can you use this feature to level your island up as quickly as possible, you  can become an Islander's Cowrie tycoon along the way!

== Agenda Support ==

ISH provides a robust suite of tools to help you create a workshop agenda that gets the most Seafarer's cowries out of your workshops.  There are several ways you can use ISH to craft a workshop agenda:

  - You can request ISH to automatically generate workshop schedules for all cycles in the current or next season based on your current game state.  For each workshop in each cycle, ISH can generate a schedule based on an algorithm that maximizes its estimated shipping value. When you make the workshop schedule generation request, you can tell ISH to avoid selecting candidate products that require specified material types or individual materials. Although ISH will create schedules for an entire season, the algorithm it uses does not attempt to predict future supply changes, but it does take the current demand shift into account to favor products from among those having approximately equal shipping values that should have a better shipping value in the future. Even though the predicted returns are a bit imprecise, by using ISH each day to generate new schedules based on current game conditions, you can easily replace your currently open workshop schedule entries with improved ones that will yield better shipping values. You can also tell ISH to prefer scheduling favors during the season, which tends to result in a lower Seafarer's cowrie total for the season, but does make it easy to quickly max out your favors for the season.  Using the automatic workshop generation feature, ISH should generate between 30,000 and 35,000 cowries per season, and, if you desire, can always ensure you max out your weekly favor tokens at 70.
  - If you are familiar with the Overseas Casuals discord channel, you know they provide nicely optimized workshop agenda recommendations and favor agenda recommendations.  ISH allows you to import that information directly into ISH, modify it if you please, and then set your in-game workshop agenda with the result. You can override individual workshop schedules for a selected cycle by replacing it with a selected schedule from an imported favors agenda.  Finally, you can have ISH automatically generate an Overseas Casuals /favors command for the current or next season's favor products and place it on the clipboard, which you can then paste into the bot-spam channel.
  - If you prefer to roll your own schedules manually, ISH allows you to view all the product supply and demand data you need to make efficient product crafting schedules in one place.  In a single table, it will show you the product, required level, hours to craft, product categories, current popularity, current supply, current demand shift, current predicted popularity, and the shipping value you can expect to receive given your current groove, current product popularity, current product supply, and your specified workshop rank.  The shipping value calculation is based on the latest crafting theory developed by the sanctuary island guru community.  All columns are sortable, so you can quickly investigate different material scenarios.  Double-clicking on a product will pop up a dialog that shows you what materials are needed for the product craft.

Once you have crafted a workshop agenda using these various methods, ISH can display a detailed breakdown of the agendas expected monetary performance: total, by cycle, and by workstation.  You can popup displays of your current or next season game workshop agenda, the last automatically generated workshop agenda, or the last workshop agenda you imported from Overseas Casuals.  This gives you an easy way to compare workshop agendas generated from different sources, possibly using different parameters, against your current game workshop agendas.


===== 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.
 
** ISH must be able to interact with the main HUD for the island to perform many of it's functions.  Please be aware that leaving ISH control windows open can cause the HUD to no longer be interactable, so be sure to close all such controls before you try to run the various ISH functions. **

===== Caveats =====

ISH should provide support for the various tasks you must perform from sanctuary level 1, but there are a few cases where you must first do something manually before ISH can help you.

1) When you first interact with the Produce NPC, you can have it do your sewing and watering of the initial 5 plots by checking "Run without using the Produce NPC".  After you complete the duty and the Produce NPC starts offering the Crop Status control ISH needs to properly manage your crops, you no longer need to use that option.

2) The situation with the first use of the Pasture NPC is different - you will need to manually complete the duty it gives you to feed the one animal you have.  After completing this the Pasture NPC will offer the Pasture Status control which is what ISH needs to take care of your animals.

3) The ISH UI allows you to select materials you many not yet have access to due to your level. I've tried to provide feedback when this happens, but there may be cases where ISH does not handle the situation properly when you try to do something you are not yet authorized to do.  Please report such circumstances so I can attempt to provide fail safes for future users.
====== UI ======

You start ISH via the FFXIVMinion menu drop down. It's under the "MistahMikey" menu item.  Clicking "Island Sanctuary Helper" 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.


__**GENERAL UI USAGE NOTE**__

When entering a value into a field control, when you begin to enter the text, the text will appear dimmed as a visual cue you are in the process of modifying the current value of the field.  The field value is not entered until you hit either the RETURN key or the TAB key, at which time the value might be checked, resulting in a popup if an error is detected. After dismissing an error popup, you should be returned to the field control to correct the error. If you navigate away from a field control by focusing other controls (say, by clicking in a different field control) before entering the value, the current value will be redisplayed and the value you were in the process of entering will be lost.

In the control descriptions, if the control label has a asterisk appended, it means that value is saved in your profile (see the Profile Tab.)

When a table has sortable columns, 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).

When a table supports searching column data for a particular entry, the following controls will appear before the table:

| Find | Text Field | Enter a search command that will be matched against one or more predetermined columns.  When a hit occurs, the row containing the hit will be scrolled to the first displayed row. If there are multiple hits, use the "Find Next" Button control to go to the next one.  When no more hits are available, you will receive a popup informing you the search will continue from the beginning of the table.  You can use the "Clear" Button control to terminate the search. |
| LUA pattern Enabled | Check Box | When checked, the search command is treated as a LUA pattern (Please see https://www.lua.org/pil/20.2.html for the details) that any column matching it will hit.  When not checked, the search command is treated as a text string that any column containing it will hit. |

===== 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. ISH can only be enabled when you are actually on the island. |
| Travel To Island | When clicked, ISH will move your character to the island by teleporting and interacting with the gateway NPC. | 
| 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 ISH 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, called material orders, to be gathered.  You can create as many material orders as you please, and select any number of them to be run. You can also direct ISH to periodically return to the Enterprising Exporter to do sell off your excess materials.

To set up the excess materials sales operation, you must enter values into two fields:  //Excess Materials Threshold//, and //Excess Materials Above Threshold//.  When both those numbers are non-zero, excess sales are enabled for all your running material orders, which will be indicated by the //Excess Materials Sales Enabled// check box being checked; to subsequently disable excess materials sales, just enter zero into one or both of those fields.  The way the excess materials sales operation works is as follows.  When the amount of material you have obtained for each material across all running material orders exceeds //Excess Materials Threshold// + //Excess Materials Above Threshold//, ISH will run your character to the Enterprising Exporter and initiate sales transactions to sell up to //Excess materials Above Threshold// materials for all materials in your material orders having a quantity over your //Excess Materials Threshold//.  After completing the sales transactions, ISH will return to gathering until it again meets the conditions to initiate another excess materials sale.  It will continually cycle between gathering and excess material selling until you explicitly disable excess material sales.

**IF YOU WANT THE EXCESS MATERIALS SALES OPERATION TO EXECUTE REPEATEDLY, YOU MUST ENSURE THAT ACROSS ALL YOUR RUNNING MATERIAL ORDERS, THE //EXCESS MATERIALS THRESHOLD// + //EXCESS MATERIALS ABOVE THRESHOLD// IS LESS THAN THE QUANITY OF MATERIALS YOU SPECIFY FOR AT LEAST ONE MATERIAL.**  So, as a simple example, if you create a material order that specifies it should complete when you have 150 Island Apples in your inventory, then one way you could enable continuous excess materials sales is by entering 100 in //Excess Materials Threshold// and entering 40 in //Excess Materials Above Threshold// (100 + 40 < 150).  Then, every time you get 140 Island Apples, ISH will pause material order filling, travel to the Enterprising Exporter, request excess materials sales transactions to sell up to 40 instances of  ALL materials you have in your materials orders with an inventory amount over 100, then return to filling the material order.  Because you are continuously depleting your Island Apple inventory to be below the 150 completion quantity you specified in the material order, the material order will never be filled.  When you have a multi-material order run, as long as this relationship holds for at least one material across all material orders you are running, the excess materials sales run will repeatedly occur.

Also, be aware that you are able to gather several types of seeds with material orders, but they cannot be sold via the Enterprising Exporter.  You can still include them in material orders that are subject to excess material sales, and they will just be skipped.


The controls for excess materials sales are:

| Excess Materials Threshold | The base number of materials in your material orders used to trigger excess materials sales. |
| Excess Materials Above Threshold | The number of materials above //Excess Materials Threshold// that will trigger excess materials sales.  Note that once this trigger level is exceeded for all materials in your materials orders, up to an //Excess Materials Above Threshold// amount of ALL those materials with a quantity above //Excess Materials Threshold// in your inventory will be sold. |
| Excess Materials Sales Enabled | To enable excess materials sales, you must enter non-zero values in the preceding two fields. When this occurs, the checkbox will be checked indicating excess materials sales is enabled. |


But before you can do any excess materials selling, you must first create Material orders, which is what the controls below the excess material sales controls allow you to do. The controls for this feature are:

| Delete  | Allows you to delete all selected material orders.                                                                                                                      |
| 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.                                                                                                                        |
| Clone   | Allows you to create a copy of an existing material order that you can subsequently edit.                                                                                    |
| 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. ISH will analyze all your selected material orders to arrive at a list of all materials that are needed.  It will then attempt to gather the required number of materials needed to fill those materials by always moving to the closest available needed material node. Please note, when the materials orders are almost completely fulfilled, there may not be enough active nodes for the remaining materials to be gathered in the areas used to gather them.  When this happens, ISH will remain in the current area and collect other nearby active nodes to force the nodes with needed materials to respawn. |

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 a material that already exists in the list, the new quantity will be added to the existing quantity.  The quantity you enter is the amount of the material you wish to have ISH place in your inventory. When a material order is run, it will terminate when ALL of the materials in your material order have the specified quantity of materials in your inventory.

The list of materials comprising the material order appears in the table. The controls for this table are:

| Delete | Deletes all selected materials from the material order. |
| 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. |
| Set Quantity| Sets the specified quantity for all selected materials. |
| 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. |


===== Capture Orders Tab =====
{{:mistahmikey:islandsanctuaryhelper:capture_orders_tab.png?400|}}

The Capture Orders Tab allows you to create, save, and run lists of animals to be captured - exactly analogous to material orders.  You can create multiple lists as you please, and select any number of them to be run. The controls for this tab are:

| Delete  | Allows you to delete all selected capture orders.                                                                                                                      |
| New     | Allows you to create a new capture order.  Prompts you for a unique name for the capture order.  The name can contain any characters that are legal for a file name.  |
| Rename  | Allows you to rename an existing capture order.                                                                                                                        |
| Clone   | Allows you to create a copy of an existing capture order that you can subsequently edit.                                                                                    |
| Edit    | Allows you to edit an existing capture order.                                                                                                                          |
| Run     | Allows you to run all selected capture orders.  This will cause your player to capture the requested animals.                                                         |


When you execute the New or Edit functions, the Capture Order Edit page is presented. 

{{:mistahmikey:islandsanctuaryhelper:capture_order_edit.png?400|}}

This page allows you to construct the list of animals that comprise a capture order.  You can add new animals, or edit existing ones, by using the entry controls above the capture order table. To add an animal to the capture order table, you select the desired animal 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 animal that already exists in the list, the new quantity will be added to the existing quantity.

The list of animals comprising the material order appears in the table. The controls for this table are:

| Delete | Deletes all selected animals from the capture order. |
| Edit | Removes the selected animal from the capture order, and sets the the values that animal had into the entry controls. You then use the entry controls as usual to modify it as you please and add it back. |
| Set Quantity| Sets the specified quantity for all selected animals. |
| Save | Persistently saves changes to the capture order |
| Exit | Returns to the Capture Orders page. If you have modified the capture order but failed to save it, you will be given an opportunity to save it before actually exiting. |

In capture order table, in addition to the animal and quantity attributes of a capture order entry, a few useful additional attributes are displayed.

| Type | The kind of animal - rare or basic |
| Eorzean Hour| The eorzean hour at which a rare animal will spawn.  All spawn durations are 3 eorzean hours. |
| Weather | The weather required for the rare animal to spawn. |
| Forecasted Spawn Time | The local time when the rare animal will spawn again.  The next animal to spawn has a asterisk next to it. If the animal is currently spawned, "Now" is displayed. |

Note:  Some rare animals have both a weather and time requirement, some only have a time requirement, and some only have a weather requirement.  ISH tracks eorzean time and weather conditions so it can give priority to capturing a rare animal when it's specific requirements have been met.  The priority scheme from highest to lowest is:  rare animal with both weather and time requirement, rare animal with only a weather requirement, rare animal with only a time requirement, basic animal.

===== Crop Management Tab =====
{{:mistahmikey:islandsanctuaryhelper:crop_management_tab.png?400|}}

The Crop Management Tab allows you to automatically cull, reap, sow, and water your farmland according to your desired crop plan. You can have up to 20 plots on your farm.  For each plot, ISH allows you to select a seed that it will sow on the plot when it becomes empty. You can also specify "none", which is necessary if you have less than the full 20 plots.  The controls for this tab are:

| Run | When clicked, your character will move to the Produce NPC and begin its management functions.  First, it will move your character to reap all plots that have ripe produce.  Next, it will determine how many plots need to be planted, check your inventory for the required seeds, and if you are short some seeds, can optionally purchase or gather them.  It will then sow plots for which you have the corresponding planned seed in your inventory.  Finally, it will water all plots for which watering is needed. |
| Run without using Produce NPC | During the early IS levels, the Produce NPC won't show you crop status or allow you to buy seeds, but ISH can still do the basis reap, sow, and water functions without interacting with the NPC if this option is checked. | 
| Buy needed seeds | If the Produce NPC has the purchase feature enabled, your character will buy needed seeds whenever this option is checked.  ** You must ensure you have sufficient Seafarer's Crowries to purchase the seeds. ** |
| Gather needed seeds | If you are short seeds that cannot be purchased and only gathered, a material order for the needed seeds will be created and executed whenever this option is checked. |
| Plots to Cull | You can enter a list of plot numbers that you wish be be culled before reaping and sowing occurs.  The plot list is comma separated with each list item being either a single plot number or a range in the form of <plotNumber>-<plotNumber>.  When you enter the plot list, the plot list items are checked for validity, and if any are invalid, you will receive a modal error popup and the entire plot list is rejected. Once you have entered a valid plot list, when you click Run, you will have to answer a modal popup that warns you the cull will take place - this is so if you forget to clear a previous plot list, you don't unintentionally cull again.  To clear an entered plot list, just delete all the characters and hit enter. Be aware that the plots you cull become sowable, so seeds for those plots will be needed as the crop management process proceeds. |

===== Pasture Management Tab =====
{{:mistahmikey:islandsanctuaryhelper:pasture_managment_tab.png?400|}}

The Pasture Management Tab allows you to automatically feed and gather leavings from the animals in your pasture.  ISH will visit each animal, employ the feeding method you've selected, then gather any leavings it may have.  Using this feature, you can easily ensure all your animals are fed to the gleeful state and therefore will drop the maximum leavings. **You must ensure you have crafted sufficient feed for ISH to use to feed your animals.** The controls for this tab are:


| Auto Feed* | When checked, ISH will determine the best feed you have available in your inventory to elevate each animal's mood. When not checked, the Feed Dropdown control will be displayed. |
| Feed Dropdown* | When Auto Feed is not checked, the Feed Dropdown control will be displayed from which you can select the specific feed to be used for all animals.  |
| Run | When clicked, your character will traverse the pasture, visiting each animal to feed and gather leavings from it. |

After you click Run, ISH will move your character to the center of the field so it can scan all the animals in your pasture.  When it completes the scan, it builds a leavings map for the animals in your pasture and displays the result in the Pasture Leavings Map table.  This table helps you understand what leavings your current pasture will yield, as well as what animals contribute them.  For each leaving, it shows you how many animals drop the normal version of the leaving (guaranteed to drop) or the rare version of the leaving (a somewhat random drop that depends on your animals' moods.)  If you double-right-click on a number in either the Normal or Rare column, another popup will appear listing the animals that provide the associated leaving.  You can use this information in conjunction with the Master Leavings Map (available from the Agenda Tools Tab) to plan what animals you need to have in your pasture to meet Workshop schedule production requirements.

===== Level Grind Tab =====
{{:mistahmikey:islandsanctuaryhelper:level_grind_tab.png?400|}}

The Level Grind Tab allows you to automatically level your island in 10 exp increments by repeatedly gathering materials from nodes in a small area. There are two areas ISH uses for this purpose - one for when your Sanctuary level is below 10, which requires no tools, and another when your Sanctuary level is at 10 or above, which requires that you've enabled flying and have the Islekeep's Bronze Beakaxe tool.

In the same way that excess materials sales work for for for Material orders, you can have ISH sell off excess materials you gather to prevent your inventory from overflowing. The difference the way excess materials are handled here, albeit the same basic process, is much simpler than with the material orders - you enter values into //Excess Materials Threshold// and //Excess Materials Above Threshold//, and then whenever all materials you wind up gathering while grinding exceed the //Excess Materials Threshold// + //Excess Materials Above Threshold// limit, ISH will run your character to the Enterprising Exporting, sell off //Excess Materials Above Threshold// of the excess, and return to grinding. You don't need to specify what materials need to be sold off - ISH automatically keeps track of all materials you gather while grinding for this purpose.

The controls for this tab are:

| Run | Start the level grind task. |
| Excess Materials Threshold | The base number of grind materials you gather used to trigger excess materials sales.  |
| Excess Materials Above Threshold | The number of grind materials above //Excess Materials Threshold// that will trigger excess materials sales.  Note that once this trigger level is exceeded for all grind materials, up to an //Excess Materials Above Threshold// amount of ALL those materials with a quantity above //Excess Materials Threshold// in your inventory will be sold. |
| Excess Materials Sales Enabled | To enable excess material selloff, you must enter non-zero values in the preceding two fields. When this occurs, the checkbox will be checked indicating excess material selloff is enabled. |
| Stop at Sanctuary Max Level | When checked, the level grind task will run until you've achieved the maximum sanctuary level.  If unchecked, the level grind task will never end, which allows you to max out your Islander's Cowries bank over time (it caps at 999,999.) |

===== Agenda Tools Tab =====
{{:mistahmikey:islandsanctuaryhelper:agenda_tools_tab.png?400|}}

The Agenda Tools Tab provides a number of features to help you create in-game workshop agendas.  The controls for this Tab are:


| Get Game Workshop Agenda Data | When clicked, moves your character to the Tactful Taskmaster and retrieves a vast array of agenda game data that is used to support other agenda tools features. As you attempt to use features that depend on agenda game data, ISH will require you to first retrieve the agenda game data, but will also require you to use it whenever your current agenda game data becomes more than an hour old. |
| View Supply and Demand Data | When clicked, pops up a window that displays a table containing currently retrieved supply and demand data. |
| Import Agenda | When clicked, parses either an Overseas Casuals workstation or favors agenda from the clipboard text for later viewing |
| Generate Current Season Workshop Agenda | When clicked, will automatically generate a workshop agenda for the current season. You will be prompted by a popup for additional optional information that will modify how that generation occurs. |
| Generate Next Season Workshop Agenda | When clicked, will automatically generate a workshop agenda for the next season. You will be prompted by a popup for additional optional information that will modify how that generation occurs. |
| View Replacement Workshop Agenda | When clicked, pops up a window that displays the currently generated or imported workshop agenda.  This agenda will be used when you click the Replace Workshop Agenda button. |
| View Current Season Game Workshop Agenda | When clicked, pops up a window that displays the current season's game workshop agenda. |
| View Next Season Game Workshop Agenda | When clicked, pops up a window that displays the next season's game workshop agenda. |
| View Favors Agenda | When clicked, pops up a window that displayed the currently imported favors agenda. |
| Replace Workshop Agenda | When clicked, replaces your current game workshop agenda to match the currently generated or imported workstation agenda. For the current season, only those portions of your game workshop agenda that are currently modifiable will be replaced. |
| Generate Current Season Favors Command | When clicked, creates an Overseas Casuals /favors command for the current season that you can paste into the bot-spam channel. |
| Generate Next Season Favors Command | When clicked, creates an Overseas Casuals /favors command for the next season that you can paste into the bot-spam channel. |
| Get Master Leavings Map | When clicked, pops up a window that displays a table showing each possible leaving, along with how many animals drop the normal or rare version of that leaving. |

=== Supply and Demand Data Popup ===
{{:mistahmikey:islandsanctuaryhelper:view_supply_and_demand_data.png?400|}}


This popup presents detailed information intended to help you manually craft an in-game workshop agenda. Each column in the product table is sortable by ascending or descending order by clicking on the up and down arrows. The columns are:  


| Product | What you can craft |
| Level | The sanctuary level required to craft the product |
| Hours | how long it takes to craft the product |
| Category 1 and 2 | The categories that determine craft efficiency |
| Popularity and Supply | Current game information used for Export Value calculation |
| Demand Shift and Predicted Popularity | Current game information that could affect your future schedule analysis |
| Shipping Value | Something not available from the game dialogs which represents the Seafarer's Cowries you can expect to receive when the craft finishes given your current workshop rank, groove, popularity state, and supply state. The Shipping Value calculation is based on the latest crafting theory resulting from the Island Sanctuary guru community, so it is fairly accurate. |

What this information allows you to do is quickly see what products will result in the best returns given current conditions, determine what materials those products require, and then decide which of those products you want to include in your schedule. By sorting the columns, you can quickly see what crafts are expected to have the highest return, which of those are appropriate to your level, which categories for those crafts are the same (so you can arrange to get the crafting efficiency bonus.)  The controls for this tab are:


| Workshop Rank | Because you might have a varying number of workshops that might be at different ranks as you level, you use this control to specify the level you which to investigate making a schedule.  The value is 1 - 5, corresponding to Workshop I through Workshop V.  This value impacts the predicted Export Value. |
| Groove (Current/Max) | Your current groove value, which impacts the predicted Export Value. |

When you RIGHT DOUBLE CLICK on a Product table row, a popup will appear that shows you what materials are required to craft the product.  

{{:mistahmikey:islandsanctuaryhelper:required_crafting_materials_popup.png?400|}}

You can pop up as many of these as you like, and you can easily use that information to create materials orders for gatherable materials. If the material category has an asterisk next to it, that means it is a rare material that must be obtained via the Excitable Exporter. If for some reason ISH could not retrieve the inventory counts for the materials, an asterisk will appear - you can try to refresh the data when this occurs. 
Please keep in mind that ISH takes a snapshot of your current state by interacting with the game controls to retrieve this information. The longer the time from when you interact with the Tactful Taskmaster, the more chance there is that something will happen externally that will change this state. So please be sure to refresh if you've had ISH open for a while to ensure you have the latest data.

=== Import Agenda ===

There are several ways to create and retrieve importable agendas using the Overseas Casuals discord channel using either the bot-spam or recommendations channels. The key to successfully importing this data is to ensure you copy the proper portion of the agenda to the clipboard.  This is accomplished by copying everything from the Season line to the bottom of the last workshop schedule provided. For an imported workstation agenda to be able to replace your in-game workstation agenda, **your in-game workshop agenda rest cycles MUST BE SET TO MATCH THE OC CASUALS SETUP, which is rest days on days one and seven.**

As an example, the following is a screen shot after executing the /next_week bot-spam command:

{{:mistahmikey:islandsanctuaryhelper:next_week.png?400|}}

In the screen shot, you can see the proper text selection to be imported.  Rest cycle information is ignored, as is other unrelated information that sometimes exists.  This same basic idea applies to the agendas generated by the /today, /this_week, and /favors bot-spam commands, or provided by recommendations channel.  Because /favors uses a significantly different format to present its agenda schedules than the other recommendations generation methods, ISH differentiates between them - you can import a current version of both separately.  This will be useful later if and when you wish to integrate selected favors agenda schedules into in-game workshop agenda by overriding specified workstation schedules in your imported workstation agenda.

=== Generate Workshop Agenda (Current or Next Season) ===

When you attempt to generate a workshop agenda, the Workshop Agenda Generation Settings popup will appear. This popup has several tabs with settings that allow you to control how ISH generates the agenda. Each time this popup is displayed, the previous settings are cleared. When you click the OK button on any of the tabs, workshop agenda generation commences. For each workshop in each cycle for the entire season, ISH will generate a schedule based on an algorithm that maximizes its estimated shipping value. The shipping value estimate used to select candidate products for a schedule is based on the community's shipping value formula using zero groove, current workshop rank, current product popularity, and current product supply. Efficient crafting is used as much as possible to maximize the shipping value and increase groove, but there are times when ISH will select a product that has a non-efficient shipping value that is higher than any efficient craft. While the shipping value estimate is only an educated guess, and thus will not equal the actual shipping value you receive, it should generally select products that are relatively desirable and will typically wind up being worth more due to the positive effects of groove increase and desirable popularity and supply changes. For the current season, ISH will generate a schedule that meshes with the current state of your game workshop agenda, so it will always "fit".  The more often you regenerate your current season workshop agenda, the more it's overall shipping value will trend towards its best possible outcome by repeatedly adjusting to the most desirable current game data conditions.  Obviously, a workshop agenda generated for the next cycle is a very coarse approximation - predicted popularity is used to estimate its product's shipping values.  You should always plan to regenerate it when it becomes the current season's game workshop agenda.

== Avoid Material Types Tab ==

{{:mistahmikey:islandsanctuaryhelper:avoid_material_types_tab.png?400|}}

By clicking on a material types and selecting them, you will prevent ISH from adding any product to a workshop agenda schedule that requires materials of those types to produce. 

== Avoid Materials Tab ==

{{:mistahmikey:islandsanctuaryhelper:avoid_materials_tab.png?400|}}

By clicking on a materials and selecting them, you will prevent ISH from adding any product to a workshop agenda schedule that requires those materials to produce. 


== Favor Settings Tab ==

{{:mistahmikey:islandsanctuaryhelper:favor_settings_tab.png?400|}}

This tab allows you to enable adding favors to your workshop agenda.

| Enable Favor Scheduling | When checked, ISH will prioritize adding favors to the workshop agenda until enough to generate the maximum allowed favor tokens per season are included (currently 70 tokens.) The favor scheduling algorithm attempts to use efficient crafts whenever possible so the tokens are generated as quickly as possible (2 per efficient favor craft.)  Be aware that this will tend to reduce your seasonal Seafarer's cowrie total, but it will ensure you max out your favor tokens each season. |
| Use Last Workshop for Favors | When checked, ISH will only use the last workshop for favor scheduling - otherwise, it will use whatever workshops it needs to generate as many favors tokens as quickly as possible. |
| Allow Schedule to Start with Favor | When checked, ISH will allow the first schedule entry to be a favor - otherwise, it will prevent using a favor as the first schedule entry.  Prohibiting the first schedule entry from being a favor - the default - tends to make it easier to generate favor tokens more quickly by creating efficient crafts. |






=== View Workshop Agenda (Generated, Imported, Game) ===
This popup window allows you to view the currently imported workshop agenda AND override selected workshop schedules within that agenda with selected favors agenda schedules.

{{:mistahmikey:islandsanctuaryhelper:view_workshop_agenda.png?400|}}

This popup contains a lot of information that can help you see how products contribute to the overall shipping value of the workshop agenda.  The shipping values are calculated using an accurate groove value for each product (based on how efficient crafts occur in the displayed workshop agenda), but only the current popularity and supply values are used. All the different workshop agenda sources have the same format, providing a series of tables that break down how the shipping value is calculated. The popup will remain displayed until specifically closed, so you can create a variety of different workshop agendas using various methods and parameters and then visually compare them as you please.

| Window Title | Provides the workshop agenda source (Generated, Imported, Game), the season (current or next), and the season date range.  If it is for the current season, the current cycle and current hour are also displayed. |

== Workshop Agenda Totals Table ==

| Total Shipping Value | The estimated Workshop Agenda shipping value for the entire season. |
| Final Groove | The highest groove value the Workshop Agenda achieved. |


== Workshop Agenda Cycle Totals Table ==

This table reflects the currently selected cycle.

| Cycle Shipping Value | The estimated shipping value for the displayed cycle. |
| Start Groove | The groove value when the cycle started. |
| End Groove | The groove value when the cycle ended. |

== Workshop Agenda Favors Table ==

This table displays information about the favors that are available for the season.

| Favor | The product name of each favor.  There will always be 3 - one for each different hour duration (4, 6, and 8.) |
| Hours | The hours required to product the favor. |
| Required | How many of the product must be made to qualify for the bonus tokens. |
| Shipped | For Game workshop agendas, this will reflect the actual number of favors shipped to date. |
| Currently Scheduled | How many favors the game sees as being scheduled. |
| Auto Scheduled | For generated workshop agendas, how many favors were automatically scheduled during schedule generation. ISH always attempts to schedule the Required number of favors. |

== Workshop Agenda Cycle Workshop Table ==

This table reflects the currently selected cycle.  There is an column for each existing workshop. Each workshop column header displays the estimated shipping value of all products in its schedule. Each workshop column data cell a workshop schedule table.

== Workshop Schedule Table ==

This table contains the workshop schedule entries.

| T | The time (24 hour clock) the product is schedule for production. |
| Product | The name of the product to be produced. When a $ appears next to the name, it is an efficient craft and thus worth double. When an * appears next to the name, it is a favor. |
| H | The number of hours the product requires to be produced. |
| SV | The estimated shipping value of the product when it is produced. |

The Cycle drop-down allows you to select the current cycle you wish to view or modify.  If you have imported a favors agenda, you can access its schedules to override selected workshop schedules in the current cycle. You do this by RIGHT CLICKING anywhere on the workshop column you wish to override.  This will result in the following popup window:

{{:mistahmikey:islandsanctuaryhelper:replace_workshop_schedule.png?400|}}

You use the Favors Schedule drop-down to select the desired schedule from the currently imported favors agenda. You can use the View Favors Agenda button to see exactly what is in the corresponding schedule.  Clicking the OK button causes the selected favors agenda schedule to override the selected workshop agenda schedule.  When this occurs, all the shipping value estimates are recalculated to reflect the modified schedule.

=== View Favors Agenda ===
This popup window allows you to view the currently imported favors agenda.  This is useful when used in conjunction with the workshop agenda schedule replacement feature of the View Workshop Agenda popup window.

{{:mistahmikey:islandsanctuaryhelper:view_favors_agenda.png?400|}}

=== Master Leavings Map ===
This popup window allows you to view the a table that show, for each possible leaving, how many animals drop its normal or rare value.

{{:mistahmikey:islandsanctuaryhelper:master_leavings_map_popup.png?400|}}

Double-right-clicking the number in the Normal or Rare column pops up a window that lists the animals that drop the associated leaving. You can use this in conjunction with the Pasture Leavings Map (available from the Pasture Management Tab) to plan what animals you need to have in your pasture to meet Workshop schedule production requirements.




=== Create Agendas Manually ===

By pasting a workstation or favors agenda you copy from Overseas Casuals into a text editor, you can easily learn how they are formatted and then create your own agendas by creating a similarly formatted agenda of your own creation. Then, you just copy that newly created gem into the clipboard and import it. Be warned, however:  ISH does not thoroughly vet the information that it parses on import (it assumes Overseas Casuals knows what it is doing to simplify the code), so you can easily create agendas that will fail when you try to set them in-game. If you choose to try this, please don't expect much support from me if you have trouble doing it - I only mention it here for those tech-savvy geeks that are capable of getting it right.  For all you others that can't - ah well ;)

=== Replace Workshop Agenda ===

By clicking this, your currently generated or imported workstation agenda, including any favors agenda schedule overrides you did, will replace the corresponding cycles in your game workshop agenda corresponding to its season. 

For an imported workshop agenda, be aware, unless you are very careful in how you create the imported text ISH parses to create a workshop or favors agenda, you can easily get a result you won't like.  You must be absolutely certain that the imported workshop agenda matches the current state of your game workshop agenda; if it doesn't, then you can expect that it will fail in various ways.  Just be aware that when you set an imported workstation agenda to become your game workshop agenda,  **FOR EVERY CYCLE IN THE IMPORTED WORKSHOP AGENDA, THE CORRESPONDING GAME WORKSHOP AGENDA CYCLE WILL HAVE ALL OF ITS CURRENT WORKSHOP SCHEDULES CLEARED** before the imported workshop agenda schedules are set.  This is true even if, for some reason, your imported workshop agenda has a cycle with, say, only one workshop schedule in it - in that situation, all the other workshop schedules in that cycle will be cleared. This normally isn't an issue, because the imported agendas typically cover all the workshops. But even then, if for some reason your imported workshop agenda is incompatible with the current game workshop agenda state, you will likely loose some number of game workshop agenda schedules.

A generated workshop agenda is always guaranteed to cover the entire season.  For the current season, only that portion of the generated workshop agenda that isn't in the past is used for replacement.  For the next season, the existing next season workshop agenda is completely replaced.

Once the replacement is completed, ISH automatically refreshes the game workshop agenda data to reflect the changes.
=== Workshop Agenda Modification Demo ===

To get a feel for you how this works, please have a look at the following screen capture where I quickly demonstrate all the main features I just described.

https://www.dropbox.com/scl/fi/wgriqkj7w4ubw0k95eaoo/workshopagenda.mp4?rlkey=nqzoriax5ua6hlnptv26dt4dy&dl=0
===== Movement Tab =====

{{:mistahmikey:islandsanctuaryhelper:movement_tab.png?400|}}

The Movement Tab allows you to control what kind of movement speed will be used to move your character within the ISH zone.  There are two types of movement speed enhancements that are used:  running speed actions and mounts. Running speed actions include Sprint, and if you use the right character, Peloton and Fists of Wind.  These are invoked as they are available when the distance you must move is fairly short as indicated by the Mount Cutoff Distance.  When the distance is longer than the Mount Cutoff Distance, a selected or random mount will be used to travel that distance.  The controls on this tab are:

| Enable Speed Actions | When checked, ISH will attempt to use speed actions (Sprint, Peloton, Fists of Wind) whenever they are available and it is appropriate. The mount will take priority if the cutoff distance requirement is met. |
| Speed Action Cutoff Distance (yalms) | The distance above which ISH will use Speed Actions to move your character. |
| Enable Mount | When checked, ISH will attempt to use a mount whenever one is available and it is appropriate. |
| Mount Cutoff Distance (yalms) | The distance above which ISH will use a mount to move your character. |
| Mount Selection | A list of mounts from which you can chose one to use whenever a mount is needed to run that long distance to the placard. Be aware that this list, due to limitations in Minion, contains more mounts than you really own. If you pick one it turns out you cannot use (because you don't own it or you are in a zone where mounts aren't allowed), a popup will appear informing you of the situation. |
| Select Random Mount | When checked, ISH will randomly pick an available mount that you own to run to the placard. This overrides your Mount Selection. |

===== Profile Tab =====
{{:mistahmikey:materialgirl:profile_tab.png?400|}}

The Profile Tab allows you to persistently store most of ISH'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 ISH 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 ISH. |
| 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. ** Be aware that profile values are only saved when you explicitly request them to be saved via the Save button. **


===== Debug Tab =====

{{:mistahmikey:materialgirl:debug_tab.png?400|}}

This tab is primarily intended for use in conjunction with consultation with ISH 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, ISH 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, ISH will include the current tick count in the debug messages. This provides information that facilitates debugging timing issues. |
| Debug Message Level Settings | ISH'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 bug support, please post a message on discord: https://discord.gg/3vdmKRdhYh.  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

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. ISH is a 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

Page Tools
