Skip to content
FXMasterFXMaster Wiki

Installation

Gambit’s FXMaster is the core module that enables functionality within Foundry. Gambit’s FXMaster+ is an expansion module that is installed in addition to FXMaster with additional effects and features.

Install Gambit’s FXMaster

Section titled “Install Gambit’s FXMaster”
  1. Open Add-on Modules from Foundry’s Setup screen.
  2. Select Install Module.
  3. Search for Gambit’s FXMaster and install the package published by me, Gambit!
  4. Launch the intended world, open Manage Modules, enable Gambit’s FXMaster, and save.
  5. Reload when Foundry requests it.

FXMaster releases and source are available in the FXMaster GitHub repository. Installing through Foundry’s package browser is normally the easiest option because Foundry can track compatible releases and available updates.

Add Gambit’s FXMaster+

Section titled “Add Gambit’s FXMaster+”
  1. Follow the Accessing FXMaster+ guide to subscribe, link Patreon to Foundry VTT, restart the server, and install the module.
  2. Enable both Gambit’s FXMaster and Gambit’s FXMaster+ in the same world.
  3. Reload when Foundry requests it.

FXMaster+ requires FXMaster to be installed and active. Update both modules together when a release requires a newer FXMaster version.

Confirm the installation

Section titled “Confirm the installation”

After loading a Scene as a GM:

  • Open the FXMaster Controls Scene Controls group.
  • Confirm that FXMaster Tools Overview, Particle Effects, Filter Effects, Manage Layers, Manage API Effects, Save Particle and Filter Effects as Macro, and Clear Scene Particle and Filter Effects (Right-click: Disable Region Effects) are available.
  • With FXMaster+ active, confirm that Manage Sound Effects and Manage User Particle Effects also appear.
  • Open Module Settings → Gambit’s FXMaster and confirm that the client and world settings are present.

Continue with the Quick Start after the controls appear.

Updating

Section titled “Updating”

Before a major Foundry or FXMaster update, back up the world. After updating:

  1. Reload when Foundry requests it.
  2. Open a Scene that already uses particles, filters, Regions, and API effects.
  3. Confirm that the effect stack and Scene Levels still display correctly.
  4. Review the release notes for migrations or renamed parameters before updating saved macros.