Enhancement Tool

The Enhancement Tool helps in creating the data for enhancements marks on class abilities. It generates the required scripts that needs to be added to a class registration, so that it can be picked up by the Enhancement Calculator.

  • Additively load the tool into FHE or GHE while the class envelope is also on the table.

  • Open the menu Options  Game Keys and bind the Game Key "Enhancement Tool: Add location". This key is used to mark a location on an ability card while hovering it with the mouse. So something like left CTRL might work well.

  • Right-click the class envelope and use the Setup Enhancements menu.

This menu will copy all cards from the "Starting Abilities" and "Advanced Abilities" deck of the class envelope and move it to the tool. The camera will adjust to focus on the tool.

deck loaded

While the deck is on the tool, you can use the Next button to move the top card from the deck, to the second position of the tool. This will then be the current card where enhancements can be edited. Clicking the Next button again, will move this card to the bottom of the deck and move the top card from the deck to the second slot again. The Previous button will do the reverse (place the current card on top of the deck and getting the new card from the bottom of the deck). Don’t draw or place cards manually and always use one of the buttons.

The current card can than be edited by using the previously defined Game Key. Hover the card with the mouse and use the Game Key. A red cross-hair icon will appear on the card. This represents the location where the Enhancement Calculator will place the enhancement stickers later on. If you are not happy with the location, e.g. because it’s too war away from the actual spot, simply use the Game Key again and the cross-hair will move to the new place.

location added

Once you selected a current location this way, the tool will show additional options on the right to configure the enhancement spot. On the top you can see two buttons to define the current action (top/bottom) as a loss action or permanent action. In Frosthaven the enhancement price is dependent on this. Once you click them, they lighten up a bit to indicate they are currently active. Clicking them again, will remove the setting for the current action.

Below, you find a checkbox that can be selected to indicate that the ability for the enhancement spot can potentially affect multiple figures/tiles/etc.

Finally, there are buttons to define the shape of the enhancement spot. This defines which enhancement stickers can be put onto the enhancement spot. Clicking a shape will highlight it and reveal the final options for the enhancement spot.

shape selected

The enhancement costs depend on the type of ability, so it needs to be selected here for each enhancement spot. Use the 4 options preceded by a summon icon for enhancement spots on summons and the other for regular abilities. If an ability doesn’t fit one of the categories, use the last "N/A" option instead. This will prevent the +1 option to show up for this enhancement spot (e.g. see ability "Flashing Flurry" of Blinkblade, where a +1 doesn’t make any sense, but is technically allowed).

There’s one option that can not be selected via the UI and has to be updated manually afterward: The movement of tokens (e.g. Deathwalker’s abilities). This can only be set in the generated script, by setting the type to move-token. The difference between the regular move type is that move-token won’t show Jump as a possible enhancement even for square shaped enhancements.

After an option was clicked, a small icon will appear on the card indicating the previously selected shape. This will happen for all added enhancements and is retained even if the card is moved to the deck again.

options selected

To remove an option again, simply use the Game Key again near the location of the icon.

For hex enhancements a different view will show. Instead of selecting the ability type (since it’s not relevant for hex enhancements), instead the number of pre-printed hexes needs to be entered into a text field. Enter the number of existing hexes and click the Apply button to add the enhancement like any other.

hex options

When all enhancements are done (or also before if you only want to generate partial scripts), use the Generate Script button. This will loop through the deck and read all added locations to generate the required script. You can find the script in the Notebook menu of TTS.

There will be 2 notebooks: "FHE 2.0" and "GHE 1.3". The first one can be used if you are only interested using the class in Frosthaven Enhanced (and also Gloomhaven Enhanced once it reaches version 2.0). The other one can be used for both version as it also includes both the new format for enhancements, and the old format used by version 1.3 of GHE.

Update the script of the class envelope to include the generated script and the class is ready to go.

ClassApi.registerClass("MyClass", {
    -- ...
    abilities =
    --- generated Script start
    {
        ["Ability 1"] = {
            -- ...
        }
    }
    --- generated Script end
})

The script will set the ability level for all abilities based on the position of the card inside the deck sheet. The last two cards in the sheet will be considered to be level 9 cards, the next two cards level 8 cards and so on. The three cards before level 2 cards are then "X" cards and everything else will be a level 1 card. If this assumption is not correct for the class, you need to update the generated script afterward by adjusting the level property of each ability. Otherwise, the campaign manager might incorrectly load the class.

The order in the deck on the table doesn’t matter. Only the order of the cards in the deck sheet is considered.