Addons
An addon is a separate program that extends the app: importing a document into a workshop, generating a prepared map, or drawing the battle board another way. A world pack reskins a setting; an addon adds a tool. The server checks an addon's results and the rules engine still resolves every move.
Where addons run
Self-hosted servers on Linux, Windows and macOS and the desktop app's own world can run addons. A container or sandbox can only start programs available inside it: an addon needing Python or Blender needs those installed there. The Android app's own world cannot run addons yet, and Android does not offer addon controls when visiting another host. Players can still use the ordinary maps and workshop content an addon produced.
Install and switch on
- Open Admin, Addons. Browse the list and read the author's name, source, requirements, permissions and any conflicts.
- Press Install. The list pins the audited commit; the server downloads the author's files and checks them before installing.
- Switch the addon on and accept the permissions it requests. Use Settings and checks to enter its settings and check required programs.
- Let setup finish. An addon may need Python packages, model downloads or a setup tool. Its card reports progress, disk requirements and failures. Needs settings or Needs setup means it is not ready to use.
The project supplies the framework and an audited list; addons remain their authors' projects. An addon runs with the server user's rights, so choose its source carefully. Its card explains what it requests. An update requesting new permissions waits for your acceptance. Addons declaring a conflict cannot run together; their cards name the conflict.
Find the added controls
- Workshop importer: Import with an addon on the workshop shelf or hub. Choose a file, review the returned bundle, untick unwanted kinds and import it as a new workshop.
- Map generator: Build a map with an addon in the workshop's map library or the DM's map drawer. The result becomes a prepared map.
- Board view: the board's View switch, with Options for this device if offered. The view gets only the map and figures its viewer may see; taps and moves use the same engine checks as the standard grid. A board view keeps the table's own zoom, fit and arrow keys, and may choose a session stage: Party above the chronicle on the left, the board in the centre, and the Hand and message box below it, falling back to the usual table if the view fails.
The first addon on the audited list is Isometric Tabletop: a Godot pixel-art board view with rotation and fog that shows players only what they may see, on Windows hosts.
Files, links and updates
Under Addon list, files and links, enable Install addons from files and links to install from a GitHub repository or choose an addon .zip. These installations are labelled unreviewed. Repository and release links follow releases; a folder link at a branch follows that branch. The card offers Update when a newer version is available.
Updates keep the addon's settings and data and repeat setup when required. Replacing an installed addon from another source asks first and starts the replacement switched off. Removing an addon deletes its package and data folder; maps and workshops it made remain.
Moving and troubleshooting
Move your world preserves addon records, settings and permissions, with secrets excluded, but leaves out addon packages and their data. Self-hosted backups copy the managed data/ tree, including addons stored in its default location; a custom ADDONS_DIR outside that tree needs a separate copy. If a destination reports Files missing, use Reinstall, then check settings and setup again.
For a missing program, open Settings and checks and use Check what it needs. For failed setup, read the card's log and use Run its setup again after fixing the cause. An addon waiting for a shared resource names what is using it and can be stopped while it waits.
ODM_ADDONS=off disables addons. ADDON_REGISTRY_URL chooses the list (off browses none), and ADDONS_DIR changes their storage location from data/addons. The repository's addon guide has the authoring and extension-point references.