Skip to content
Encounter+ Docs

Schema reference

Reference for the JSON formats the app reads and writes, generated from its data model.

API

Section titled “API”
Schema Description
Combatant One participant in a combat, and the mutable state that belongs to this fight.
Game The live combat state of a Campaign.
Message One entry in a campaign’s chat and dice log.
Role Which side a creature is on.
WSEvent One message on the WebSocket connection between the app and its clients.

Container

Section titled “Container”
Schema Description
Campaign A container for an ongoing game run by the user.
Module A container for a distributable body of game content.
System An installed game system — the ruleset that defines what content looks like.

Content

Section titled “Content”
Schema Description
Encounter A prepared fight, ready to be loaded into combat.
Group A folder in a container’s library tree.
Map A battle map — the playing surface and everything placed on it.
Page A page of written content — the prose half of an adventure.
Reference A shortcut to other content, placed in a container’s library tree.

Definitions

Section titled “Definitions”
Schema Description
DataTransform A declarative recipe for enriching an entity’s JSON context before it is rendered.
EntityDefinition EntityDefinition describes the structure, behavior, and resources associated with a type of game entity
FormDefinition A comprehensive definition structure for building dynamic, configurable forms
TemplateDefinition
ThemeDefinition A comprehensive theming system for customizing the visual appearance of native views
ViewDefinition A declarative UI definition structure for building dynamic, data-driven layouts.

Entity

Section titled “Entity”
Schema Description
Entity A flexible, game-agnostic entity representation for tabletop RPG content.
Modifier A rule modifier that changes an entity attribute.
StatusEffect A condition or ongoing effect on a Combatant.
Table A random table that can be rolled on.

Map

Section titled “Map”
Schema Description
AreaEffect A marked-out area on a Map — a spell template or zone.
Asset A reusable piece of artwork placed on a Map.
Aura A radial area drawn around a Token, moving with it.
Light A light source on a Map.
Marker A point of interest pinned to a Map.
Measurement A distance measurement drawn on a Map.
Tile A piece of scenery placed on a Map.
Token A creature placed on a Map.
Vision What a Token can see, and what it carries to see by.

Package

Section titled “Package”
Schema Description
Package A downloadable System or Module listed in the content catalog.

Shared

Section titled “Shared”
Schema Description
AnyRealmValue A enum for storing and retrieving values associated with an AnyRealmValue property.