0.9.3 Advantage Automation || Macro: Toggle Compendium Pack Visibility || Toolkit Maintenance

This release adds further Advantage automation and handling improvements, and provides content management and module maintenance features:

1. Extends Advantage automation for outmanoeuvring, winning opposed tests, suffering conditions, and losing momentum (when not accrued in a round).
2. Adds new macro to Toggle Compendium Pack Visibility.
3. Adds new content maintenance option in module settings to easily re-import Toolkit macros and tables.

See the changelog for other changes (including compatibility and maintenance improvements) and below for further details on key updates in this release.

GM Toolkit v0.9.3 maintains compatibility with WFRP4e v5 and FVTT v9.

Improvements to Advantage automation and handling

The Advantage automation introduced in v0.8.0 has been extended and improved.

• Each Advantage automation scenario is optional, and can be enabled or disabled through the Configure Advantage Handling module setting.
• The Advantage features apply to individuals as per core rulebook, rather than group Advantage introduced in Up in Arms.

Key improvements are:

• Changed Advantage automation to represent Outmanoeuvring, where an opponent is wounded without engaging in an Opposed Test during combat. (WFRP p164).
  • In Foundry, tests should be targeted and handled as unopposed.
  • The advantage updates are made only when using an Apply Damage option by right-clicking the results card in the chat log (if enabled in settings).
  • Advantage is increased for the winner and cleared for the loser.
• Added automation for winning Opposed Tests, regardless of applying damage. [#83]
  • A new module setting is added to automate Advantage handling when winning or losing opposed tests. This is separate to the Outmanoeuvring setting.
  • Advantage is increased for the winner of a test and cleared for the loser.
  • No damage needs to have been applied, so this iteration covers situations where a character successfully Dodges or otherwise uses a non-damaging skill to successfully oppose.
  • Changes are applied as soon as the defender rolls. Be aware that updates may therefore be duplicated if the roll is edited or re-rolled by using Fortune or Dark Deal.
• Added Advantage automation when suffering a new Condition during combat (WFRP p167) [#84] .
  • This is not applied to Foundry status 'conditions' such as Dead, Grappling and Fear.
  • Advantage is cleared when a new condition is added to a character. In the case of stackable conditions (such as Bleeding), the Advantage loss is not re-applied if the character already has an instance of the condition.
• Added option to confirm reducing combatant Advantage when it has not accrued in a round (WFRP p164) [#91].
  • A new module setting is added to enable or disable dialog prompt at the end of each combat round that allows GMs to see who has last momentum and to select which combatants should lose Advantage.
  • Characters who have not increased Advantage since the start of the round are pre-selected to lose 1 Advantage.
  • GMs can override default selections before confirming Advantage losses.
  • Changes made are confirmed in a chat whisper to the GM, which can be revealed to players.

Additional changes include:

• Added flags to prevent increasing Advantage multiple times when successfully opposing or outmanoeuvring multiple targets.
• Added checks to ensure automated Advantage handling and macro-based Advantage updates only apply to characters in an active combat.
  • The exception is the Clear Advantage macro, which can be used outside of combat to reset token actor Advantage to 0 (zero).
  • A notification is shown if the Winning or Outmanoeuvring automation options are enabled but either character in the test is not in the active combat.
• Changed Advantage UI notifications to only present to GM users. This is introduced to prevent token or actor names being revealed to players. This will not prevent names being revealed in chat log messages, such as for opposed test results. [#87]

New Macro: Toggle Compendium Pack Visibility

Added new macro to Toggle Compendium Pack Visibility [#99].

• Use this macro to hide or show compendium packs, such as premium content scenes, journal entries and actors that may include spoiler or sensitive information that you want to make sure players cannot see.
• The macro can be modified to toggle visibility of packs from only specific sources (such as wfrp4e-core) and/or types (eg, Actors, Items, RollTables etc).
• If no specific criteria or source is set, all packs from modules declared for the wfrp4e system are included.
• Setting the forcePrivate variable to true in the macro will force visibility to hidden, rather than toggle current state.

New Feature: Toolkit Content Maintenance

Added new option in module settings to Update GM Toolkit Content. [#97]

• It is recommended to use this option when upgrading to a new version of the module to ensure you have the latest macro and table content.
• Content is imported from compendium packs into the GM Toolkit Macro Directory folder or RollTable folder, depending on document type being imported.
• Existing content in the folder is removed, so any customizations should be moved to a separate location first. As compendium IDs are retained, you may need to save a duplicate of customized content if the original import has been changed.
• The Maintenance dialog shows version numbers for world and compendium content, so you can more easily identify if an item has been updated for a release.
• The Maintenance dialog also shows the database ID of the item. This can be used to identify existing duplicate world content (such as customised table or macro in a different folder location) that prevents re-importing.

Existing Macro Updates

All of the macros have been updated in v0.9.3, and most with breaking changes. Use the Update GM Toolkit Content option in module settings to ensure you are using the latest compatible macro versions in your game world.

• Fixed compatibility with Advanced Macros [#86]
  • Add XP [#90], Reset Fortune and Session Turnover [#85] macros no longer throw an error if the Advanced Macros module is also active.
  • These macros will need to be manually re-imported from the compendium for changes to apply.
• Changed references to Global Illumination to Unrestricted Token Vision, to align with changes in Foundry scene configuration options.
  • This affects the Toggle Scene Visibility and Light macro, which should be manually re-imported from the compendium for changes to apply.
• Added notes footer to Advantage suite and Toggle Scene Visibility and Light macros.
  • This includes macro description, version number and date plus usage tips.
  • This change standardises the presentation of in-context macro documentation across the suite.
• Changed Advantage macros to reflect refactored Advantage class. [#98]
  • The Advantage suite macros (Add, Reduce and Clear Advantage) will need to be re-imported from the compendium for changes to apply.
• Added localisation improvements to Pull Everyone to Scene and GM Toolbox macros. Thanks @Yasnen for contributing these! [#92]
  • The Pull Everyone to Scene and GM Toolbox macros will need to be re-imported from the compendium for localization and related improvements to apply.
• All of the existing macros have been updated to include version flags, which are currently used for the Toolkit Content Maintenance routine. [#97]

Token Hud Extensions

• Fixed missing Token Hud Extension options for players who don't have access to configure tokens. The layout of Token Hud Extensions has been reorganised as a result of this change. [#67]

Localization

• Added Japanese language support. Thanks @Yasnen for contributing these! [#92]
• Added several new localization strings to support Advantage automation and content maintenance features.
• Changed various localization strings, including some Advantage related settings and messages, as well as references to Global Illumination (in favour of Unrestricted Vision).

Other

• Changed Dark Whispers table icon from default d20 to match the Send Dark Whispers icon.
• Changed compendium pack definitions to use field 'type' instead of deprecated 'entity'.
• Added new functions to utility module, along with various other refactor and housekeeping updates.