How johnnolan/wild-magic-surge-5e works
Wild Magic Surge 5e is a Foundry VTT module that automates D&D 5e Wild Magic checks and effects. The main flow is game activity entering the module, spell/actor validation, a mode-specific surge check, then chat/table output and optional follow-up effects. Settings panels configure the behavior; actor resources and flags support tracking. The README documents several capabilities whose source wiring was not sampled, so those relationships are shown only where documented; unsampled implementation details are not inferred.
Main entry points: MagicSurgeCheck.ts Surge Check · module.ts Module Hooks · SpellParser.ts Spell & Actor Parser · SurgeDetails.ts Surge Details
Components 23
Surge Runtime
- Module Hooks
scripts/module.ts - Surge Check
scripts/MagicSurgeCheck.ts - Actor Resources & Flags
scripts/utils/Resource.ts
Check Rules
- Spell & Actor Parser
scripts/utils/SpellParser.ts - Surge Details
scripts/utils/SurgeDetails.ts - Standard Check
scripts/MagicSurgeCheck.ts - Incremental Check
scripts/utils/IncrementalCheck.ts - Descending Dice
scripts/utils/DieDescending.ts - Spell-Level Rules
scripts/utils/SpellLevelTrigger.ts - Combat Round Check
scripts/RoundCheck.ts - D&D 5e Adapter
scripts/utils/Dnd5eSystem.ts
Surge Effects
- Tides of Chaos
scripts/TidesOfChaos.ts - Surge Tables
scripts/RollTableMagicSurge.ts - Chat Output
scripts/Chat.ts - Surge Macro
scripts/TriggerMacro.ts - Surge Animation
scripts/AutoEffects.ts - Custom Hooks
scripts/utils/CallHooks.ts
Settings
- Settings Registry
scripts/utils/TypedSettings.ts - Settings Panels
scripts/panels/SettingsPanelBase.ts - Settings Setup
scripts/ModuleSettings.ts
Other components
- GM / Player
- Foundry VTT
- Dice So Nice
Connections 24
- GM / Player → Foundry VTT: plays in
- Foundry VTT → Module Hooks: delivers game hooks
- Module Hooks → Surge Check: routes checks
- Surge Check → Surge Details: builds details
scripts/MagicSurgeCheck.ts - Surge Details → Spell & Actor Parser: uses spell parsing
- Spell & Actor Parser → D&D 5e Adapter: checks D&D data
scripts/utils/SpellParser.ts - Surge Check → Incremental Check: runs incremental
scripts/MagicSurgeCheck.ts - Surge Check → Descending Dice: gets die formula
scripts/MagicSurgeCheck.ts - Surge Check → Spell-Level Rules: gets roll formula
scripts/MagicSurgeCheck.ts - Foundry VTT → Combat Round Check: starts combat turns
- Combat Round Check → Surge Check: checks threshold
- Surge Check → Tides of Chaos: checks recharge
scripts/MagicSurgeCheck.ts - Surge Check → Surge Tables: draws surge table
scripts/MagicSurgeCheck.ts - Surge Check → Chat Output: sends results
scripts/MagicSurgeCheck.ts - Surge Check → Surge Macro: executes configured macro
scripts/MagicSurgeCheck.ts - Surge Check → Surge Animation: plays effect
scripts/MagicSurgeCheck.ts - Surge Check → Custom Hooks: emits custom hooks
scripts/MagicSurgeCheck.ts - Surge Check → Actor Resources & Flags: updates actor flags
scripts/MagicSurgeCheck.ts - Tides of Chaos → D&D 5e Adapter: reads D&D resources
scripts/TidesOfChaos.ts - Surge Tables → Chat Output: posts table result
scripts/RollTableMagicSurge.ts - Settings Panels → Settings Registry: reads and updates
- Settings Setup → Settings Panels: registers panels
scripts/ModuleSettings.ts - Surge Check → Settings Registry: reads options
scripts/MagicSurgeCheck.ts - Surge Animation → Dice So Nice: integrates optionally