User Tools

Site Tools


island_sanctuary_helper

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
island_sanctuary_helper [2023/12/11 14:15] – [What it does] mistahmikeyisland_sanctuary_helper [2025/04/10 03:14] (current) – [UI] mistahmikey
Line 61: Line 61:
  
 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. 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 ===== ===== Main Tab =====
Line 175: Line 189:
 | Run | When clicked, your character will traverse the pasture, visiting each animal to feed and gather leavings from it. | | 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 ===== ===== Level Grind Tab =====
Line 209: Line 224:
 | 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 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. | | 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 === === Supply and Demand Data Popup ===
Line 250: Line 266:
 === Generate Workshop Agenda (Current or Next Season) === === 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.  The more often you regenerate your current workshop agenda, the more it's overall shipping value will reflect 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 current.+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 == == Avoid Material Types Tab ==
Line 271: Line 287:
 This tab allows you to enable adding favors to your workshop agenda. 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 collect the maximum allowed favor tokens per season are included (70 tokens will be collected.) The algorithm used attempts to use efficient crafts whenever possible so the tokens are generated as quickly as possible.  This will tend to reduce your seasonal Seafarer's cowrie totals, but it will ensure you max out your favor tokens each season. |+| 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. | | 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 tends to make it easier to generate favor tokens more quickly by creating efficient crafts (which results in 2 favor token rather than 1.) |+| 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. |
  
  
Line 285: Line 301:
 {{:mistahmikey:islandsanctuaryhelper:view_workshop_agenda.png?400|}} {{: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.  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.+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. | | 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. |
Line 318: Line 334:
 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. 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 ==+== Workshop Schedule Table ==
  
 This table contains the workshop schedule entries. This table contains the workshop schedule entries.
Line 333: Line 349:
 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. 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 ==+=== 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. 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|}} {{: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.
 +
 +
  
  
Line 397: Line 422:
 ====== Support ====== ====== Support ======
  
-For support or requests, please contact me on discord: https://discord.gg/3vdmKRdhYh.  I will respond as soon as I am able, generally within 24 hours at most.+For bug support, please post a message on discord: https://discord.gg/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: When you need support, please provide me, at a minimum, the following:
island_sanctuary_helper.1702304154.txt.gz · Last modified: 2023/12/11 14:15 by mistahmikey

Page Tools