- JavaScript 100%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| assets | ||
| lang | ||
| scripts | ||
| .gitattributes | ||
| .gitignore | ||
| LICENSE | ||
| module.json | ||
| README.md | ||
| THIRD_PARTY.md | ||
AmbientFX
Dust in a sunlit room, smoke from a chimney, snow over a courtyard or fireflies around a pond. Draw a Region, add an [AFX] behavior and adjust the effect. It plays for everyone viewing that Region's Level, with no macros or extra modules.
Effects
- Dust Motes, Mist / Haze and Fireflies / Motes for calm atmosphere
- Rain, Snow and Drifting Debris (leaves, petals, ash) for weather
- Fire, Embers, Smoke / Steam and Sparks / Crackle for sources
- Vortex, Ripples / Pulses and Perimeter / Ward for magic, water and zone edges
Every effect takes your own textures and colours, density, size and motion. Sizes and speeds use grid spaces, so settings scale with the map. Several behaviors can share one Region.
Using it
- Draw a Region around the area, or around a small source.
- In its Behaviors tab, add an [AFX] behavior and save.
- Adjust Appearance, Motion and Advanced tuning.
Most effects stay inside the Region and respect its holes; sources such as Fire and Smoke can spread beyond it unless Keep inside Region is on. With Levels, assign the Region to the floors where it should appear.
Good to know
- Layer draws the particles below tiles, between tiles and tokens, or above both. RegionFX uses the same three layers.
- On movement lets a token-attached Region's effect travel with the token (Carry) or leave a trail (Trail).
- Effects are visual only: flames don't emit light, so add an Ambient Light separately.
- Hiding a Region stops its effects for everyone; its Visibility setting controls who sees the outline.
- GMs can toggle an effect from a macro:
await ambientFX.toggle("Campfire"), using the Region's unique name.
Settings
- AmbientFX animations (per user): On, Off, or follow the system's reduced-motion preference.
- AmbientFX particle budget (per user): caps particle counts on this computer (default 1,500).
Requirements
- Foundry VTT v14
Installation
In Foundry's Add-on Modules tab, choose Install Module and paste this manifest URL:
https://someto.de/flaig/ambientFX/releases/download/latest/module.json
This is a personal project and stays at 0.x: expect breaking changes between versions.
Credits
Bundled textures include work by Kenney, WickedInsignia, LFA, AntumDeluge and Map Shine. See texture sources and licenses.
AI disclosure
This module was created by AI with the help of human ideas.
License
MIT. Bundled textures retain their own licenses.