Skip to main content

Welcome

Welcome to the Splash documentation.

Splash turns Foundry journal pages into interactive fullscreen handouts — splash screens that cover the canvas, clickable puzzles and combination locks, table-wide votes, and branching story screens. You build them in a visual editor and show them to your players from the scene controls, from a journal page, or from a trigger like a player clicking a locked door.

Quickstart​

Start with Getting Started for installation and your first splash.

Feature guides​

  • The Splash Editor — building a splash from objects, states, and layout
  • Layers & Modes — scene, HUD, full, and handout presentations; local vs synced
  • Actions & Interactivity — buttons, value-driven conditions, puzzles, and inline-macro scripts
  • Synced Mode — shared state across the table, with players driving it through the GM
  • Triggers — launching a splash when a player clicks a locked door or enters a region
  • Presets & Prefabs — the preset library and ready-made prefabs like the tumbler lock
  • Effects & Animations — shader effects, entrance and exit animations, and the renderer
  • API — registering custom sprite, action, effect, and trigger types

Foundry compatibility​

  • Minimum: 13.344
  • Maximum: 14

Splash requires lib-wrapper.