leanFX

leanFX is a shader effects engine for Foundry VTT v14, derived from Token Magic FX. It keeps Token Magic FX's 45 filters and its animation vocabulary, without user interface, presets or compendiums. You apply effects with a small API from macros or from your own module. Effects are saved on the Token, Tile, Drawing or Region and appear on every client.

await leanFX.addUpdateFiltersOnSelected([{
  filterType: "glow", filterId: "ward",
  color: 0x66ccff, outerStrength: 4, distance: 12,
  animated: {outerStrength: {animType: "syncCosOscillation", loopDuration: 3000, val1: 2, val2: 5}}
}]);

Quick start

1. Install leanFX (Foundry v14) and socketlib, and enable both in your world.
2. Select a Token, Tile or Drawing on its layer.
3. Create a Script macro with the snippet above and run it.

Remove the effect again with await leanFX.deleteFiltersOnSelected("ward").

Pages

• API Reference: targets, every method, return values and errors.
• Filter Specs: what a filter spec contains; padding, gridPadding, sticky, zOrder; validation rules.
• Region rendering: gameplay visibility, placement among tiles and tokens, effects on the map under a Region (backdrop), effects that turn with their token, elevation and previews.
• Animation: the 19 animation modes, their options and how timing works.
• Filters: all 45 filters with their parameters, defaults and an example each: Color and Tone · Glow and Shadow · Distortion and Motion · Elemental · Magic · Images
• Blend Modes: the numbers behind blend.
• Sync and Permissions: who can change effects, how they reach other clients, previews.
• Examples: copy-paste macros.
• Coming from Token Magic FX: what is the same, what changed, how to convert a preset.

What leanFX does not do

No Token HUD buttons, editors or preset galleries; no compendium of macros; no automatic effects on templates or spells; no game-system integration; no video textures. leanFX does not read Token Magic FX flags or presets.

---

leanFX and this documentation are licensed under the GPL-3.0. leanFX is a modified version of Token Magic FX by SecretFire and contributors; several examples here adapt Token Magic FX presets. See THIRD_PARTY.md.