Group combatants in the Combat Tracker and roll for group initiative.
In the setup screen, use the URL https://github.com/arcanistzed/ctg/releases/latest/download/module.json to install the module.
After creating a new combat, the combatants in the Combat Tracker will be instantly grouped and put into toggles. The toggles will open when they contain the current combatant unless this is disabled in settings.
This module also allows for an easy way to roll group initiative.
If you hold the Control or Shift key while rolling the initiative of any of the combatants from the tracker, it will automatically give all of the combatants in the same group the initiative value rolled.
If you use the "Roll All" button, all groups will be rolled for.
If you use the "Roll NPCs" button, all groups with only NPCs will be rolled for.
Please note that this doesn't work in "None" mode and you must roll from the tracker for this to work.
The Group Skipping feature skips over the rest of combatants in the current group when advancing the turn tracker. It's recommended to use this with Combatant Sorting enabled.
When enabled, CTG attempts to sort combatants by their group which is the optimal order for group skipping. It compares numbers numerically (e.g. in Initiative mode), strings alphabetically (e.g. in Name mode), and the rest by ID (e.g. in "Selection" mode).
The way that the groups are created depends on the selected mode which you can change near the top of the Combat Tracker by clicking on one of the boxes.
You can create or remove grouping modes in module settings, configuring them as you wish. For example, if you want to create a mode named "NPC" which groups based on the Combatant's isNPC property, you would insert this in the config:
There are also a some modes provided by default:
This doesn't apply any groupings.
Hidden for the Simultaneous Combat System
This is the default mode. Combatants are grouped by their initiative value.
Combatants are alphabetically grouped by their name.
Combatants are grouped by selecting their tokens. Select some tokens and then click on the button in the token scene controls toolbar to group them. Click on it again to ungroup.
Combatants are grouped by the players that have Owner permission for the associated Actor. If multiple players have ownership over an Actor, the associated combatant(s) will be grouped together with any other combatant which the same exact players have ownership over.
Group combatants by their associated Actor which allows you to group together Combatants which are from the same Actor, but have different names (such as when using Token Mold).
Group combatants with checkboxes that appear next to each one. You can use this mode to keep track of who has gone so far in combat, for example, which is especially useful for users of the Simultaneous Combat System.
Group combatants by their Actor type. This is useful because it allows separating player characters abd NPCs in many game systems.
Requires Mob Attack Tool)
This mode is only shown when Group combatants by MAT's saved mobs.
Requires Lancer Initiative
Group combatants by their Lancer Initiative activations value.
The "Initiative" mode is hidden when the Simultaneous Combat System module is enabled.
When enabled, a new "Mob" mode is added allowing you to group combatants by their MAT mob.
There is also a button beside each group allowing you to save it as a MAT mob.
When the "Hide Actor Names" functionality of CUB is enabled, the group names reflect the replacement names.
When enabled, there is a mode which allows you to group combatants by their Lancer Initiative activations value.
When Lancer Initiative's initiative rolling button setting is enabled, you can use it's small d20 icon to roll group initiative as normal.
The module provides various hooks and methods which other developers can use to integrate with the module:
Fires whenever the mode is updated with the only argument as the new mode.
Fires whenever the groups are updated with the following arguments: the new groups, the current mode, and whether this update is being done with a popOut Combat Tracker.
This fires immediately after a new group is created by selection. The only argument is the array of new Combatant ID & CTG Group ID pairs.
These hooks fire whenever group initiative is rolled. The first two are associated with the "Roll All" and "Roll NPCs" header buttons, while the third hook is called when the group initiative roll is triggered for only one group.
The arguments for these hooks are: an array with the Combatant IDs and the new initiative values, the Roll Object, and the IDs of the Combatant(s) who triggered the roll (this is only used for the ctgRoll hook).
Among others, these are some useful methods that can be found under game.modules.get("ctg").api:
An array of grouping modes which are used by the module. You can push or remove items from this in order to create custom or different modes. All items must be arrays and must only have two elements: the name of the mode and followed by the "path" to this data relative to the Combatant.
Ex: You could use this code in order to create a mode called "NPC", allowing Combatants to be grouped by whether ot not they are NPCs:
game.modules.get("ctg").api.MODES.push(["NPC", "isNPC"]);If you think you have a good idea for a grouping mode, feel free to suggest it and it could be added to the module for everyone!
This method generates the name which is displayed for a given group (an array of Combatants).
This boolean tracks whether or not the user is currently holding down the group initiative rolling keybind (the default for that is SHIFT or CONTROL).
This method returns the current sorted array of groups (which are arrays of Combatants). You must pass a valid mode when calling this and the groups will be created based on it's path.
Please consider supporting me on my Patreon if you like my work. You can see a list of all my projects on my website.
You can submit bugs via Github Issues or on my Discord server.
- Not compatible with the old Group Initiative module (which this module is a superset of)
- Doesn't re-render Combat Tracker Groups when MAT Mobs are changed from the MAT application window
Come hang out on my my Discord server or click here to send me an email.
Copyright © 2021 arcanist
This package is under an MIT license and the Foundry Virtual Tabletop Limited License Agreement for module development.