6.0.1 Polish Translation || Welcome & Maintenance

This patch release raises the minimum compatibility to FVTT 10.288 and WFRP4e 6.1.4.

What's Changed

Bug Fixes

• Fixed issue where the game would not be paused for connected players when the GM ran the Session Turnover macro. #182
• Fixed error when applying damage or making ranged attacks outside of combat when using group advantage. Thanks @silentmark! a186651
• Fixed module setting for Spectator notifications to not be suppressed by default. Unassigned characters were still being overlooked when experiencing issues with some macros that require an assigned actor. #192
• Fixed issue where the Add Advantage macro be capped when using Group Advantage. #194
• Fixed issue where Toolkit Maintenance would not show compendium versions of macros. #176

Localization

• Added Polish localization. Thanks @twisniowski and @silentmark! #188
• Fixed issue where Launch Damage Console was not translated in Toolkit Maintenance dialog. #177

New Feature: Welcome Message

• Added welcome message and invitation to feedback that is shown to GMs when updating or first installing the module. #196
• The message is saved in the chat log, and
  • confirms the installed version
  • links to release notes
  • provides quick access buttons to update macro and table content.

Maintenance and Documentation

• Added headline features (with wiki links) to README to make it easier for users to get an overview of what's available in the Toolkit suite. #178
• Added advice about replacing macro hotbar shortcuts to avoid compatibility issues. #181
• Added version and download stat shields to README, to make it easy to see key install data for users and repo owner. #190

New Contributors

• @silentmark and @twisniowski made their first contribution in #188

Full Changelog: 6.0.0...6.0.1

6.0.0 FVTT v10.284 Compatibility || Damage Console

Release Summary

This release confirms Foundry v10 compatibility, building on changes introduced in Release Candidate v0.9.5, and as defined in issue #156 .

Requires at least Foundry v10.284 and WFRP 6.1.2.

Feature Updates

In addition to v10 compatibility, this release:

• Adds the Damage Console, from which GMs can quickly set and apply damage to one or more actors without starting a combat, opposed or other test. See below for key features. #158
• Fixes an issue where a combatant could gain Advantage from an Opposed Test they won but did not initiate when Group Advantage is being used. #159
• Changes Group Test behaviour to clear or restore the custom skill field if a skill is chosen from the skill list dropdown. #160

Repository Management

Module management and repository changes have also been made:

• Version numbering is overhauled, essentially to keep in step with WFRP4e system versioning.
  • This is marked by a jump from v0.* to 6.*.
  • There is no v1-v5 of GM Toolkit.
• Templates are provided for bug reports, feature suggestions and pull requests.
• Discussions are enabled on the repository. I intend to use these to solicit input and feedback on new features, enhancements and potential bugs.

Damage Console

Issue: #158. Pull Request: #168.

• Access from the Launch Damage Console macro or the GM Toolbox.
• Target tokens before launching to change the pre-selected characters.
• Set damage as a roll formula or fixed amount.
• Optionally randomise damage and hit location for each target.
• Choose whether to ignore Armour Points and/or Toughness Bonus, and whether to apply a minimum of 1 damage.
• Check tooltips to find randomisation details.

What's Changed

• Add compatibility for Foundry VTT v10 and WFRP4e v6 #162
• Add templates for issues and PRs #163 #164 #171
• Clear or restore default Group Test skill #160 #166
• Prevent advantage gain if not initiating challenge #159 #167
• Add Damage Console #158 #168
• Add release workflow #169
• 6.0.0 macro versioning #173

Full Changelog: v0.9.4.4...6.0.0

0.9.5 Release Candidate FVTT v10.279 / WFRP4e v6.00

What's Changed

Added compatibility for Foundry VTT v10. This is a breaking change:

• Foundry VTT v9 is no longer supported beyond GM Toolkit v0.9.4.4.
• Foundry VTT v10 the minimum version required for this and subsequent versions of GM Toolkit.
• Full details of changes made can be found in #156.
• Nearly all macros have been updated. These can be re-imported using the Update GM Toolkit module setting. eafade2

Full Changelog: v0.9.4.4...v10

0.9.4.4 Group Advantage Automation Fix

What's Changed

• Fixed regression that prevented Group Advantage from updating in some cases. It should now update correctly whether using the Advantage macros or completing an automated process, such as outmanoeuvring or winning an opposed test.

Full Changelog: v0.9.4.3...v0.9.4.4

0.9.4.3 Advantage Permission Notices || Default Group Settings

What's Changed

A number of macro updates in this patch release ... use the Update Toolkit Content setting to import the latest versions.

• Fixed issue where players would see permission errors during advantage updates on other users' actors. #150 #152
• Added new option to set party (player-assigned: default) or company (player-owned) actors as default group type for Session Turnover macros. #151 #153
  • The Reset Fortune and Add XP macros use the Session Turnover Default Group Selection option.
  • Actors who are not character type, but are player-owned (ie, NPC, vehicle and creature type actors) are ignored whe processing Session Turnover macros.
• Added new option to set party (player-assigned: default) or company (player-owned) actors as default group type for Send Dark Whispers macro. #151 #153
  • When using company as the default group, it is possible to select unassigned players. In this case, no whisper is sent unless the 'Send to player owners' option is selected in the Send Dark Whispers dialog.
• Added new localisation keys to support additional dialog and settings options for default group selections. #151

Full Changelog: v0.9.4.2...v0.9.4.3

0.9.4.2 Localization Fixes || German Support

What's Changed

• Add localization for Group Tests and Check Conditions by @Txus5012 in #141
• Add German localisation by @24Nomad in #144 and #145
• Add compatibility with Babele #135 in #146
  • The skill list is now compiled after Babele has initialised compendiums.
  • Quicktest settings may need to be manually reset for Babele users.

Full Changelog: v0.9.4-1...v0.9.4.2

0.9.4-1 Bugfix || Check Conditions

What's Changed

• Fixed Token Hud Extension not rendering bug in #132
• Fixed not being able to respond to Dark Whispers in #137
• Fixed HUD localization errors #107 by @Yasnen in #134
• Updated Japanese translations for 0.9.4-1 by @Yasnen in #133 #138 0f620b0
• Added new macro to Check Conditions at the end of a combat round for tokens in the scene. (Thanks to @totalgit for the inspiration.) #138

Known Issue: The Group Test skill list entries are not translated. In some cases this appears to affect Babel translation of compendium skill items. #135

New Macro: Check Conditions

• Makes Endurance tests for all tokens with Stunned and Poisoned conditions, removing conditions if successful.
• Makes Cool tests for tokens with Broken conditions, removing conditions if successful. The Roll Dialog is shown so the correct difficulty can be set according to the situation.
• Removes Surprised condition.
• Applies Ablaze damage, including to vehicles.
• Parameters for the checkConditions() function at the top of the macro can be adjusted to
  • run tests at any time (default: end of combat round only).
  • apply to player-assigned characters (default: actors not assigned to players only).
• Condition checks are reported in the chat log.
  • All tests made are reported as GM-only rolls.
  • A chat message summarises any conditions removed (not shown if none are removed).
  • The standard system message for applying basic damage is shown for Ablaze damage.
• Tests fallback to Toughness or Willpower if the token doesn't have the correct basic skill.

Full Changelog: v0.9.4...v0.9.4-1

0.9.4 Group Advantage || Group Tests || Spectators || Group Selection in Macros

This release adds improvements that make group-related functions easier to handle and more consistent:

• Extends Advantage automation to support implementation of Group Advantage (from WFRP4e 5.4.0)
• Overhaul of group tests to support non-player characters, default test settings and improved user experience
• Spectator alert when users do not have players assigned, which can interfere with correct behaviour of other functions

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.4 maintains compatibility with WFRP4e v5.4.0 and FVTT v9.

Group Advantage Automation

• Added compatibility with Group Advantage implementation. [#112]
  • Removed user notifications reporting individual Advantage changes. Reasons for change (such as "PC outmanoeuvred NPC") are still shown, though may linger longer than Group Advantage messages if they are set to persist.
  • The following options are ignored, as if they are disabled, when Group Advantage is being used:
    • Suffering a condition
    • Losing momentum (individual momentum is not applied if Group Advantage is used)
    • Adding to combat (if Group Advantage is used, the system handles syncing individual advantage with the group)
  • Only Advantage gains from Opposed Tests and Outmanoeuvring are applied (losers do not lose Advantage automatically when Group Advantage is used).
  • Advantage gain is not flagged when a combatant charges.
• Fixed Advantage updates when an opposed roll is resolved by a player that does not have owner permission on the opposing actor or token. [#105]

Group Tests

Added Group Test user interface, functionality and module settings [#63]. This replaces the Make Secret Party Test macro. Key functional differences are:

• Support for non-party targets:
  • non-assigned player owned characters (eg, henchmen and hirelings).
  • non-player tokens in a scene.
• Added option to set group test difficulty in addition to test modifier.
• SL Bonus and Success Bonus are no longer supported in bypass mode (though you can use the roll dialog to add these)
• Improved user experience through custom set up form, group reporting and intelligent target selection.

User Settings

Added new module settings menu (Configure Group Test Options) to store Group Test preferences and defaults:

• Support choice of party (player-assigned characters) or company (non-vehicle player-owned actors) as default player group.
• Support four (4) user-defined Quick Test options, based on skills in active compendiums.
• Support additional custom skill (with or without specialisation), which is used as the default skill when launching the test setup form.
• Default test parameters can be set for rollmode (chat visibility), modifier, difficulty and fallback.
  • Clearing the test difficulty parameter (effectively to default) uses the system default mode for determining standard test difficulty.
• Added further option to step-adjust difficulty of Advanced Skill tests where an actor does not have the required skill, and when falling back to a characteristic test.
  • The number of Difficulty steps to apply is set in a new Group Test module setting 'Step Adjust Difficulty on Fallback'.
  • If set to 0, no adjustment is made.
  • If a step-adjustment is set, then the difficulty set in the group test is ignored for those actors where a fallback characteristic test is applied. The default system difficulty is used as the basis for adjustment.
• The Summarise Group Test Results Threshold option can be set to determine whether to show summary results messages in chat:
  • 0-: never
  • 1: always
  • 2+: only if there are this many test results to show (default)

Set up Group Test Form

Added new user interface to launch and quickly set up group tests.

• Select from a list of player characters (in party or company) as well as tokens in scene. Group tests can be run across a mix of player and non-player actors.
• Automatically pre-selects targets based on tokens selected in scene.
  • If no token is selected, all player group tokens are pre-selected for test.
  • Otherwise, only selected player and non-player tokens are pre-selected.
  • Vehicles are filtered out of token selections.
• Group test options (rollmode, modifier, difficulty, fallback) are automatically defaulted to user settings preferences.
• Hint prompt displayed to add Specialisation if an undefined grouped skill is selected.
• Setting SL Bonus or Success Bonus for silent tests is no longer supported (though you can unselect the Bypass Test Dialog option use the roll dialog to add these).

Make Secret Group Test Macro

Changed Make Secret Party Test to reflect new Group Test features, replacing with Make Secret Group Test macro.

• Added clearer inline macro guidance notes.
  • The strong recommendation is to configure Group Test options via module settings.
  • However, the macro can be used to override individual parameters.
• Added support for silent group tests.
  • Set the interactive parameter in the macro to false to bypass the Set up Group Test form entirely.
  • This will use default test parameters as defined in module settings, or with overrides provided in the macro.

Chat Message Reporting

Added new aggregate group test reporting via chatlog.

• Group Test results are optionally reported in a single GM whisper message to complement individual test cards.
• The message summarises:
  • Skill and test parameters (difficulty, modifier, fallback, bypass, difficulty step) (in chat card heading tooltip)
  • Individual test results (actor, SL, outcome and description, roll, target)
  • Successful actors are visually indicated with a checkmark
  • Narrative description of results based on success levels (in SL tooltip)
  • The characteristic tested is appended to a result line if the actor does not have the Advanced Skill and the Fallback option is in play
• Reporting can be suppressed or made conditional on the test count in user settings.

Spectators

If players do not have characters assigned (and not just have owner permission), some GM Toolkit functionality (such as Add XP, Reset Fortune, Send Dark Whispers and Group Tests) may not work as expected .

• Added notification showing those users that do not have characters assigned. GM Toolkit refers to these as Spectators. [#102]
• Added module setting to 'Suppress Spectator Notification' if preferred (enabled by default).
• Spectators are also listed in the GM's console log.

Macros

Use the Update GM Toolkit Content option in module settings to import the latest versions of macros.

• Fixed an issue with the Add XP macro, where it would fail for a character with 0 XP, who had also never previously had XP.
  • The macro will need to be re-imported from the compendium to use the fix.
  • Thanks to @Kayne and @LEGION001 for flagging and helping to isolate and test a fix.
• Fixed both Add XP and Reset Fortune macros to enforce that a character must be assigned to (and not just owned by) a player user.
• Changed the Make Secret Party Test macro to use new group test functionality. This is renamed to Make Secret Group Test, to reflect the significant overhaul of the functionality.
• Changed Send Dark Whispers macro to use group selection, enabling selection by actor rather than player.
  • Default "party" selection enforces that a character must be assigned to a player. [#58]
  • Added an option to send a dark whisper to each player owner rather than just the assigned player.
  • Hovering over the character name lists all player owners as well as the assigned player.
• Removed the module setting to define default targets for Dark Whispers.
  • Instead, all party members are listed in the Send Dark Whispers dialog.
  • Any eligible actor tokens that are targeted in the scene are pre-checked.
• Changed localization key references in Send Dark Whispers, Reset Fortune, Set Token Vision and Light.
• Changed Macro Toolbox to reflect updated macro names.

Group Selection

Added getGroup() utility for more consistent group selection, to be used by macros and other functionality and for setting default filter criteria.

• The function returns an array of users, characters, tokens or combatants.
• This is used internally within the GM Toolkit but is accessible to macro and other module authors.
• Group selection can be optionally filtered by assigned user status. Actors that are not assigned to players are removed from filtered results, but will appear in unfiltered results.

More details can be found on the wiki.

Localization

• Removed some localization strings for for skills, talents and status that are now being provided by the WFRP4e system. These affect:
  • Feature: Token Hud Extension
  • Macros: Send Dark Whispers, Reset Fortune, Set Token Vision and Light
• Added several new l...

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.

Hotfix 0.9.2

• Fix Dark Whispers table and localization issues.
  • Correct duplicate numbering in Dark Whispers table.
  • Apply localization to Dark Whispers table check (requires re-importing of macro from compendium).
• Fix an issue where Advantage is always handled automatically when applying damage, even if the option is not selected.