company_workshop_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.
======= Company Workshop Helper (CWH) =======
{{:mistahmikey:companyworkshophelper:companyworkshophelper.png?400|}}

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

Tired of using internet sites to figure out how to build the components you can make using the Fabrication Station?  Hate the tedium of turning in all the materials needed to build a component? Then Company Workshop Helper (CWH) is for you.  With CWH, you can:

  * Craft any selected component from the Company Crafting Log. 
    * Get a list of all materials needed to fully craft the component and see which ones are missing from your inventory.
    * Create a JSON list of missing materials that can be used in crafting apps like Creator or Lisbeth.
    * Automatically turn in materials for all phases and retrieve the completed component into your inventory.
    * Start new crafts or finish a craft that is in progress.
  * Determine the best build configuration for submersibles or airships given a rank and a prioritized list of attributes to be maximized: surveillance, retrieval, speed, range, and favor.

===== Requirements =====

You must also download MistahMikeysLib from the store. It's free, of course.

CWH supports the following languages:  EN, FR, JP, KR, CN, and TC. 

** Note: I can test CWH for EN, FR, and JP, but am unable to do so on KR, CN, or TC (I don't have access to a Company Workshop on those clients.) However, all translations are in place, and if there are any issues with them, I am happy to work with you to get them right. **

You must ensure FFXIV, Minion, and CWH are always updated to their latest versions.

======= UI =======

You start CWH via the FFXIVMinion menu drop down. It's under the "MistahMikey" menu item.  Clicking "Company Workshop 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.


===== Main Tab =====
{{:mistahmikey:companyworkshophelper:main_tab.png?400|}}

This tab generally controls the overall operation of CWH. The controls on this tab are:

| Enabled* | When checked, enables you to travel to chosen locations. |
| 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 CWH Discord channel if you need support.  Be advised I am in the Eastern Time zone (UTC-05:00). |

===== Company Crafting Log Tab =====
{{:mistahmikey:companyworkshophelper:companycraftinglog1_tab.png?600|}}

This tab allows you to begin construction of a component. When the "Begin Construction" button is clicked, your character will automatically move to the Fabrication Station and open the Company Crafting Log (CCL). If no mesh exists for your company workshop, one will automatically be created and saved. When the CCL is opened, the tab display changes to something like this:

{{:mistahmikey:companyworkshophelper:companycraftinglog2_tab.png?600|}}

The display will reflect whatever component is currently selected in the CCL to be crafted. CWH will retrieve the current craft status from the game and set the display values accordingly. If no craft is in progress, then any component can be selected and crafted.  If a craft is in-progress, then any component can be selected (for the purpose of discovering what materials are needed to craft it), but only the in-progress craft can continue to be crafted; information describing the current state of an in-progress craft is displayed at the top of the tab.

For the currently selected component, a Materials table containing all the materials needed to construct the component is displayed.  For each material, the following information is provided:  "Needed" (how many total are needed to complete the craft), "Turned-in" (how many have been turned-in so far), "Remaining" (how many are remaining to be turned-in), "Available" (how many are currently in inventory, and "Missing" (how many need to be made before turn-ins can be completed.)

If the craft has any materials missing, a "Create JSON" button will be displayed. Clicking it will result in a JSON file being created that can be used to craft the missing materials. The format is compatible for being imported into Lisbeth; it will also be able to be imported into Creator after a future update.  A popup appears showing you the path of the JSON file created.

Finally, the "Craft Component" button initiates the component construction process.  CWH will pop up the Material Delivery control and interact with it as needed to turn in the required materials.  During each turn-in, it will automatically lower the quality of HQ materials as needed, and if the NQ materials are distributed across multiple stacks, merge them into a single stack suitable for turn in.  CWH will turn in all the materials needed for all phases.  Once all phases are complete, CWH will retrieve the completed component into your inventory.
===== Submersible Build Tab =====
{{:mistahmikey:companyworkshophelper:submersiblebuild_tab.png?600|}}

This tab allows you to determine, for a given submersible rank, what configuration of components will maximize the values of a prioritized list of component attributes: surveillance, retrieval, speed, range, favor.  The components chosen will also not exceed the maximum capacity requirements.  You can select the order in which the attributes will be maximized: in the example, for each slot, the first pass will accumulate the components that have the highest possible surveillance value; then, from those components, the second pass will accumulate the components that have the highest possible retrieval value; and so on until all attributes have been visited. A summary line is displayed that shows the values achieved for all the attributes across all slots. These values include the rank-specific bonuses submersibles receive.
As you change the attribute selected in any pulldown, the selected attributes for the other pulldowns will automatically adjust so that only unique attributes are displayed. For example, if I changed the Surveillance value to Favor, the currently selected Favor pulldown changes to Surveillance.
===== Airship Build Tab =====
{{:mistahmikey:companyworkshophelper:airshipbuild_tab.png?600|}}

This tab allows you to determine, for a given airship rank, what configuration of components will maximize the values of a prioritized list of component attributes: surveillance, retrieval, speed, range, favor.  The components chosen will also not exceed the maximum capacity requirements.  You can select the order in which the attributes will be maximized: in the example, for each slot, the first pass will accumulate the components that have the highest possible surveillance value; then, from those components, the second pass will accumulate the components that have the highest possible retrieval value; and so on until all attributes have been visited. A summary line is displayed that shows the values achieved for all the attributes across all slots. 
As you change the attribute selected in any pulldown, the selected attributes for the other pulldowns will automatically adjust so that only unique attributes are displayed. For example, if I changed the Surveillance value to Favor, the currently selected Favor pulldown changes to Surveillance.
===== Movement Tab =====
{{:mistahmikey:companyworkshophelper: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 zones CWH visits.  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 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, CWH 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 CWH will use Speed Actions to move your character. |
| Enable Mount | When checked, CWH will attempt to use a mount whenever one is available, and it is appropriate. |
| Mount Cutoff Distance (yalms) | The distance above which CWH will use a mount to move your character. |
| Mount Selection | A list of mounts from which you can choose 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 are in a zone where mounts aren't allowed), a popup will appear informing you of the situation. |
| Select Random Mount | When checked, CWH will randomly pick an available mount that you own to run to the placard. This overrides your Mount Selection. |

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

The Profile Tab allows you to persistently store most of CWH'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 CWH 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 CWH. |
| 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:companyworkshophelper:debug_tab.png?400|}}

This tab is primarily intended for use in conjunction with consultation with CWH support.  It enables various test scenarios and debugging information that are used to help diagnose issues that might occur during CWH’s operation.  The controls on this tab are:

| Enable Log file | When checked, CWH 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, CWH will include the current tick count in the debug messages. This provides information that facilitates debugging timing issues. |
| Debug Message Level Settings | CWH'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 “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/BgUJE8GnWJ.  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 is 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 CWH 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. CWH 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. If 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
