Package Description
This module provide various bits of functionality to help automate the Wild Magic Surge
feat.
Prerequisites
Ensure your Player Character has the Wild Magic Surge
feat added to the character sheet. It will not run on any characters that do not have this set.
When they cast a spell at Level 1 or higher it will trigger the check for a surge based on your options selected from the settings. All options are explained below.
Features
- Default: On a roll of 1, trigger a Wild Magic Surge (Default and can be configured in the Dice Formula options)
- Incremental Check: Every time a spell is cast, the threshold is increased by 1 for a Surge. Once triggered the threshold is reset back to 1.
- Incremental Check (Chaotic): For the amazingly awesome chaotic players and GMs. Instead of checking every time a spell is cast, at the start of every turn in combat, the threshold is increased by
1
for a Surge to a maximum of10
. Once triggered the threshold is reset back to1
. - Spell Level Dependent Rolls: Wild Magic Surge triggers dependent on spell level (Set options below).
- Descending Dice: On no Surge roll d20,d12,d10,d8,d6 then d4 until a surge, then reset back to d20.
Barbarian - Path of Wild Magic - Tasha's Cauldron of Everything: When you enter a Rage as a Wild Magic Barbarian, the module will auto roll on a table. Must enable Enable Auto Roll on a Wild Magic Surge Table
to work. Specify a custom table (TCOE table not included).
Also
- Prompt to roll on a 1st level or higher spell slot used with the
Wild Magic Surge
feat - Whisper results to GM
- Auto roll for Wild Magic Surge
- Auto roll Custom Roll Table for effect
Tides of Chaos
auto recharge- Custom dice roll check for surge
- default is
1d20
and a roll of1
- Can also set multiple target results using a comma seperated value list
- default is
- Ability to set your own roll evaluation dependent on the spell level used
- Hooks for custom macros and other modules to use
- Track incremental wild magic surge count on token
- Optionally track NPCs Wild Magic Surges
- Adds
Dice So Nice
integration if the module is enabled - Discern between sorcerer spells and other spells when multiclassing
Hooks
I have added in hooks for the following events. This allows other developers or macro users to listen for events from the result of a Wild Magic Surge and add their own custom scripts.
wild-magic-surge-5e.DieDescendingChanged
Example
Hooks.on("wild-magic-surge-5e.DieDescendingChanged", (diceFormula) => {
console.log('The current dice being rolled is {diceFormula}')
});
Runs when you set the module to prompt you when a spell is used by a PC with the Wild Magic Feat. Returns true
.
wild-magic-surge-5e.IncrementalCheckChanged
Example
Hooks.on("wild-magic-surge-5e.IncrementalCheckChanged", (num) => {
console.log('The current charge value is {num}')
});
Runs when you set the module to prompt you when a spell is used by a PC with the Wild Magic Feat. Returns true
.
wild-magic-surge-5e.CheckForSurge
Example
Hooks.on("wild-magic-surge-5e.CheckForSurge", () => {
console.log('I must prompt to get them to roll a d20!')
});
Runs when you set the module to prompt you when a spell is used by a PC with the Wild Magic Feat. Returns true
.
wild-magic-surge-5e.IsWildMagicSurge
Example
Hooks.on("wild-magic-surge-5e.IsWildMagicSurge", (isWildMagicSurge) => {
console.log(isWildMagicSurge)
});
Runs when you set the module to auto roll a check for you. The result of the roll will trigger this hook and return whether it is a surge and the roll value.
true
= The PC has triggered a Wild Magic Surge
{
surge: true,
result: 1,
}
false
= The PC has not triggered a Wild Magic Surge
{
surge: false,
result: 12,
}
Options
Track incremental wild magic surge count on token
To view your count on your token, set the following flag flags.wild-magic-surge-5e.surge_increment_resource
to be tracked.
Settings
Choose between the following options
- Default: On a roll of 1, trigger a Wild Magic Surge (Default and can be configured in the Dice Formula options)
- Incremental Check: Every time a spell is cast, the threshold is increased by 1 for a Surge. Once triggered the threshold is reset back to 1.
- Incremental Check (Chaotic): For the amazingly awesome chaotic players and GMs. Instead of checking every time a spell is cast, at the start of every turn in combat, the threshold is increased by
1
for a Surge to a maximum of10
. Once triggered the threshold is reset back to1
. - Spell Level Dependent Rolls: Wild Magic Surge triggers dependent on spell level (Set options below).
Whisper chat results to GM
Whisper all message to the GM in case you want to be nice and fudge the rolls.
Auto Roll a check for Wild Magic Surge instead of just a reminder to roll
The additional option Auto Roll for a Wild Magic Surge instead of just the prompt
will auto roll in the background for you and post the result in the Chat.
Based on your settings, it will show a prompt that a Wild Magic Surge
has occured or not.
This message is configurable should you wish.
Send Incremental Check charge to chat
When enabled, each time a incremental check for a surge changes it is posted to Chat for others to see.
Enable Auto Roll on a Wild Magic Surge Table
This option takes things a step further and will roll a Roll Table on a Wild Magic Surge
.
You can configure a Custom Roll Table by replacing the default name in the settings with your own version.
Tides of Chaos Recharge
Another option allows you to recharge Tides of Chaos
automatically on a Wild Magic Surge
.
Dice Formula
Set a custom dice formula you want to roll to check for a Wild Magic Surge
. The default is 1d20
.
The target result of the dice roll
What is the dice roll result you want to check against. The default is 1
.
Can also set multiple target results using a comma seperated value list like 1, 3, 5, 10, 19
Roll result boolean expression
Based on the target dice roll, should the result be less/greater than or equal to the result to trigger the Wild Magic Surge
. The default is =
.
Setup varying Wild Magic Surge triggers dependent on spell level
Adds the ability to set your own roll evaluation dependent on the spell level used.
For example
- A lvl 1 spell only triggers wild magic if a 1 is rolled on the d20
- A lvl 4 spell triggers if a 4 or lower is rolled
- A lvl 9 triggers if a 9 or lower is rolled
Special thanks to Jackolas126 for this suggestion.
Spell Regex for Multiclass spells
The RegEx to differentiate between sorcerer spells and non sorcerer spells. This assumes the sorcerer spells to be renamed like Magic Missile (S)
. Special characters must be escaped!
Special thanks to Jakob Huber for this suggestion and Pull Request.
Issues or Bugs?
Please report any issues you find to the github issues repo, I will aim to get to them as soon as possible! https://github.com/johnnolan/wild-magic-surge-5e/issues
Required Game Systems
- DnD5e Latest Version: Version 2.0.0-alpha2 Last Updated 1 day, 3 hours ago
Tagged Categories
Available Versions
-
Version 0.1.2
-
Version 0.2.0
-
Version 0.3.0
-
Version 0.3.1
-
Version 0.5.5
-
Version 0.6.0
-
Version 0.7.0
-
Version 0.7.1
-
Version 0.8.1
-
Version 0.8.2
-
Version 0.8.3
-
Version 0.8.4
-
Version 0.8.5
-
Version 0.8.6
-
Version 0.9.0
-
Version 0.10.0
-
Version 0.20.0
-
Version 0.20.1
-
Version 1.0.0
-
Version 1.1.0
-
Version 1.2.0
-
Version 1.3.0
-
Version 1.3.1
-
Version 1.3.2
-
Version 1.4.0
-
Version 1.5.0
-
Version 1.6.0
-
Version 1.7.0
-
Version 1.8.0
-
Version 1.8.1
-
Version 1.9.0
-
Version 1.9.1
-
Version 1.9.2
-
Version 1.11.0
-
Version 1.11.1
-
Version 1.12.0
-
Version 2.2.0
-
Version 2.3.0
-
Version 2.3.2
-
Version 2.3.5
-
Version 3.1.1