FXMaster Integration
Calendaria integrates with the FXMaster module to project weather visual effects onto the Foundry canvas.
How it works
Section titled “How it works”Each weather preset can map to an FXMaster effect. When weather changes, Calendaria sends the mapped effect to FXMaster for canvas rendering.
- If FXMaster is not installed or inactive, canvas effects are skipped. The HUD dome effects and ambient sound still work independently
- FXMaster effects can be overridden per-preset in the Weather Editor or temporarily in the Weather Picker
- The effect dropdowns in Weather Editor and Weather Picker show only the effects available to your installation
See Weather Presets for the complete mapping of presets to FXMaster effects.
FXMaster+
Section titled “FXMaster+”Some canvas effects are enhanced or available only with FXMaster+. Calendaria detects which version is installed and filters the available effects.
Wind direction passthrough
Section titled “Wind direction passthrough”Calendaria passes the current wind direction to FXMaster. Rain and snow angle with the wind.
Density, speed, and color
Section titled “Density, speed, and color”The Weather Picker includes FX Density, FX Speed, and FX Color controls that override the particle behavior sent to FXMaster:
- FX Density: density level for particle effects
- FX Speed: speed level for particle effects
- FX Color: color input for effect tint override
Built-in presets carry optional FX Density and FX Speed defaults. Many leave one or both unset, and only some specify tuned values. Saved custom presets also store these values.
A global Weather Effect Speed multiplier in Settings Panel > Weather tab > FXMaster Integration scales the speed of every Calendaria-driven preset. See the Settings page for the range and default. When the multiplier is the neutral value, the raw speed label is forwarded to FXMaster unchanged. Otherwise preset speed labels resolve to FXMaster’s relative-level numeric scale and are multiplied before being sent.
Render layers
Section titled “Render layers”Three toggles in Settings Panel > Weather tab > FXMaster Integration control which canvas layer weather particles render beneath:
- Below Tokens: particles render under the token layer
- Below Tiles: particles render under the tile layer
- Below Foreground: particles render under the foreground layer
You can combine these toggles. See the Settings page for defaults.
Particle splash
Section titled “Particle splash”The Particle Splash toggle controls whether rain and snow render a ground splash where particles land. Disable it for scenes with no ground plane. See the Settings page.
Activate by Darkness
Section titled “Activate by Darkness”The Activate by Darkness toggle gates weather effects to a scene-darkness window. When enabled, weather particles appear only while the scene’s darkness level falls within a minimum and maximum bound. Each bound runs from 0 (full daylight) to 1 (full darkness). Weather is hidden whenever the scene darkness sits outside the window. See the Settings page for the controls and defaults.
Global disable
Section titled “Global disable”The Enable Weather FX world setting (Settings Panel > Weather tab > FXMaster Integration fieldset) is a global toggle. When disabled, all FXMaster particle effects and weather sounds stop unless a scene’s Weather FX Override is set to On.
Per-scene top-down override
Section titled “Per-scene top-down override”Individual scenes can override the global Top-Down Mode setting via Scene Configuration > Calendaria tab > Weather FX View Mode:
- Use Global: follow the module-level Top-Down Mode setting
- Top-Down: force top-down rendering on this scene
- Side View: force side-view rendering on this scene
Per-scene splash override
Section titled “Per-scene splash override”Individual scenes can override the global Particle Splash setting via Scene Configuration > Calendaria tab > Weather FX Splash:
- Use Global Setting: follow the module-level Particle Splash toggle
- Show Splash: force the ground splash on for this scene
- No Splash: force the ground splash off for this scene
Per-scene override
Section titled “Per-scene override”Individual scenes can override the global Enable Weather FX setting via the Scene Configuration > Calendaria tab > Weather FX Override select:
- Inherit (Global Setting): follow the module-level Enable Weather FX toggle
- On: force FXMaster weather effects active on this scene even when the global setting is off
- Off: force FXMaster weather effects off on this scene even when the global setting is on
When the resolved state is off:
- FXMaster weather effects are not sent to this scene
- Ambient weather sounds are silenced on this scene
- The change takes effect immediately, with no reload needed
- HUD dome effects are not affected; they render in the HUD widget, not on the canvas
Per-scene weather effect levels
Section titled “Per-scene weather effect levels”On scenes that define native scene levels, Scene Configuration > Calendaria tab > Weather Effect Levels lets you restrict weather FX to selected levels. Choose one or more levels and weather particles render only on those levels. With no levels selected, weather renders across the whole scene. The control is hidden on scenes that define no levels.
Ambient sound system
Section titled “Ambient sound system”Calendaria includes a native ambient sound system independent of FXMaster. Weather presets can trigger looping audio files that play through Foundry’s environment audio context.
Crossfade behavior
Section titled “Crossfade behavior”When weather changes, the old sound fades out while the new sound fades in. Players hear no abrupt audio cut.
Controls
Section titled “Controls”- Sound Effects setting (Settings Panel > Weather tab > Weather Generation) toggles ambient sound globally
- Sound Volume slider (Settings Panel > Weather tab) controls weather sound volume
- Per-scene Disable Weather Sound flag suppresses sound on a specific scene without affecting visual effects. Sound is also silenced when the resolved Weather FX Override is Off
- Foundry scene regions with the Suppress Weather behavior mute Calendaria’s ambient sound while the player’s controlled or owned token is inside the region
- Sounds play through Foundry’s environment audio channel
- Sound assignments can be customized per-preset via the Weather Editor