Skip to content

0.8 Advantage Automation || Settings || Session Turnover || Secret Party Tests || GM Toolbox
Compare
Choose a tag to compare
@Jagusti Jagusti released this 31 Dec 06:19
v0.8.0
7102521

This release is the final version for WFRP4e 4.x and Foundry 0.8.x.

The focus has been a long overdue refactoring to support ES modules, use some native system utilities and enable future Toolkit improvements. Some features have been rewritten and extended as part of this process.

  1. GM Toolkit settings are already numerous, and only likely to grow in the future. These are now better organised into related feature areas. which will hopefully make it easier to find and adjust settings to suit your game. Some settings have been removed.
  2. Advantage handling has been overhauled and some experimental automation has been extended to support common scenarios (such as dealing damage in opposed tests).
  3. The Reset Fortune and Add XP macros no longer rely on targeting tokens in a scene. Notifications for these have been consolidated.
  4. The Session Turnover macro (formerly End of Session Routine) has been extended to support holding scenes and session references.
  5. An easily customisable GM Toolbox has been added to give ready access to frequently used macros while freeing up hotbar space.

See the Changelog for other changes and below for further details on key updates in this release.

Compatibility

Version 0.8 of the GM Toolkit is the final version compatible with, and requires:

  • Foundry VTT: 0.8.8 - 0.8.9
  • WFRP4e: 4.0.6 - 4.3.1

This version (including new enhancements) is partially compatible with WFRP4e 5.x and Foundry 9.x. Known conflicts are described in issue #69, and will be addressed in the next release. Future versions of the Toolkit may not be compatible with earlier versions of Foundry or the WFRP4e system.

There are no external dependencies.

Update to Settings

  • Added new submenus to declutter the Module Settings menu, and separate options out for:
    • Advantage Handling, including automation and notification options
    • Session Management, including Add XP, Chat Export and Pull to Scene options as well as new options for Session Turnover and Holding Scene.
    • Token Vision, including Normal and Dark Vision ranges, and Night Vision / Dark Vision overrides
    • Dark Whispers, including default target selection and message template
  • Removed the Clear Advantage in a Scene setting, which is replaced with separate settings for clearing Advantage when adding and removing combatants.
  • Removed the Token Hud Extension setting for optionally showing Initiative on scenes with active combat. This is now always shown.
  • Added fallback option to test against characteristic if actor does not have the right Advanced skill.

Existing Macro Updates

The following existing macros have been updated and will need to be manually re-imported from the compendium to work as intended:

  • Add Advantage, Clear Advantage and Reduce Advantage (see Advantage Handling and Automation below)
  • Reset Fortune
  • Add XP
  • Session Turnover (previously End of Session Routine)
  • Make Secret Party Tests

Reset Fortune

  • Removed the need to target tokens to use the Reset Fortune macro.
    • In fact, actors do not need to have tokens at all, in the visible or another scene.
    • All character actors that have an assigned player will have their Fortune reset when the macro is run either directly or through the Session Turnover routine, regardless of token selection or targeting.
  • Changed Reset Fortune notifications to be reported in a single consolidated chat message, rather than a separate message for each update.

Add XP

  • Changed the need to target tokens to use the Add XP macro.
    • If no tokens are targeted, all character actors that have an assigned player will have their Experience Points and experience log updated when the Add XP macro is run either directly or through the Session Turnover Routine.
    • If tokens are targeted on a scene, updates will only be applied to character actors that have been targeted.
  • Added a preview list of characters that will be affected to the Add XP prompt.
  • Added a reason field to the Add XP prompt to describe the change in the experience log.
  • Added a new option in Session Management settings to set a default reason. Two variables can be used to automatically include the session date and/or reference (such as session number or description).
    • %date% is drawn from the Next Session Date, which can be changed through the Edit World settings.
    • %session% is taken from a new Session Reference option in the Session Management Settings.
  • Changed notifications to be reported in a single consolidated GM whisper message, rather than a separate message for each update.
    • As before, this includes starting and updated values for current and total XP.
    • However, as the routine now uses native system functionality to update Experience Points, actors will be notified in chat with single messages.

Session Turnover (previously End of Session Routine)

  • Changed macro name from End of Session Routine to Session Turnover to avoid confusion, as not all routines necessarily happen at the end of the session (eg, Fortune is technically reset at the start of session).
  • Added option to record Session Reference
    • The %session% parameter can be used to include the Session Reference in the default reason for awarding XP.
    • If a whole number, this may be automatically incremented as part of the Session Turnover macro.
    • Whether an integer or other phrase, the reference for the next session can be manually overridden as part of this process.
  • Added routine to change the scene when pausing the game through Session Turnover. This can be used to automatically transition to a holding page, landing page or other campaign hub for downtime or between sessions.
  • Fixed an issue where non-GM users could run the routine.

Make Secret Party Tests

  • Added fallback whereby related characteristic will always be tested for Basic skills, even if they are not listed.
  • Added option to fallback to characteristic test in lieu of Advanced skill test if the option is selected in module settings.

Advantage Handling and Automation

This release introduces some experimental changes to extend Advantage automation, initially covering some (but probably not all) common Winning, Outmanoeuvre, Losing Opposed Tests and Losing Wounds situations (see p164 of the WFRP4e Core Rulebook). The GM Toolkit cannot ever provide complete automation for Advantage handling, for the same reason that it won't be offered in the base Foundry system (there are simply too non-computable and discretionary variables). However, this scenario seems common and is hopefully reliably enough handled to provide some helpful automation assistance for players and GMs. If it does, other scenarios may be added in future updates.

  • Changed the Add Advantage and Reduce Advantage to now only apply to characters that are in an Encounter on the Combat Tracker.
  • Added two settings to automatically reset Advantage when a token is (1) added to or (2) removed from the Combat Tracker.
    • These replace the previous setting to optionally Clear Advantage across all tokens in a scene (rather than an individual combat) at the start and/or end of an encounter.
    • This does not affect native system functionality to clear combatant Advantage when a combat is ended or deleted.
  • Added an option to automatically update Advantage when wounds are dealt. If selected:
    • The option is triggered when using the Apply Damage option from a test card result in chat.
    • If Wounds are dealt, Advantage is increased by 1 for the winner of the test.
    • If Wounds are dealt, Advantage is cleared to 0 for the losing target.
  • Added an option to persist Advantage handling notifications in the user interface, to give better visibility of automation incidents, in case they need to be reverted or are not applied when expected.
    • Subsequent notification messages (including warnings and errors) will be queued and shown after persisted messages are dismissed.
    • This setting is disabled by default to avoid missing other messages that are presented.
    • Notifications are also saved in the GM's browser console until the console log is reset.
  • Added support for applying Advantage changes to non-token actors, which enables tapping into hooks for more nuanced automation.
  • Added support for Advantage context, which will help with more specific notifications and handling in different automation scenarios.

Macro Toolbox

  • Added new macro - GM Toolkit Macros - to macro compendium.
  • This launches a persistent dialog for quick access to Toolkit and other macros, without taking up hotbar slots.
  • The dialog can be minimised to take up less scene area, but still be handy for quick access.
  • The Toolbox macro can be easily customised for a tailored GM workspace to show only select macros.

General Module Stuff

  • Added support for Developer Mode module and cleared out a lot of existing logging to reduce console noise.
  • Converted scripts to ES modules, and started the process of creating reusable utility functions to improve code consistency.
  • Added game.gmtoolkit. namespace which can be used by macros and other modules to tap into exposed GM Toolkit functionality.
  • More localization additions and improvements. This does leave some French translation strings behind.
Assets 4
Loading