Marker

A point of interest pinned to a Map.

Markers are how a map is annotated and connected to the rest of the content: a numbered pin on a dungeon room that opens the page describing it, a note to the game master, or a link to the next map. Tapping one follows its reference.

Markers default to hidden, so annotations do not leak to the players until deliberately revealed.

• SeeAlso: Map, MarkerShape, MarkerStyle

View JSON Schema

Property	Type	Required	Description
id	string	Yes	The unique identifier for this marker. A UUID string automatically generated when the marker is created. This serves as the primary key in the Realm database.
label	string	Yes	The short text drawn on the marker itself. Examples: "1", "2a" — keyed room numbers
color	string	Yes	The marker’s color, as an RGB string. Examples: "#ff0000"
shape	string	Yes	The marker’s shape, as the raw value of a MarkerShape. Use shapeValue for the typed form. Examples: "pin", "marker", "circle", "label"
size	string	Yes	The marker’s size, as the raw value of a MarkerSize. Use sizeValue for the typed form. Examples: "tiny", "small", "medium", "large", "huge"
name	string	Yes	The marker’s title, shown when it is opened. Examples: "Goblin Ambush"
descr	string	Yes	The marker’s description. Read-aloud text or notes shown when the marker is tapped, for markers that carry their content inline rather than linking elsewhere.
reference	string	No	A soft link to the content this marker opens. May be an app link or an external web address. Examples: "/page/goblin-ambush"; "/map/cragmaw-hideout"; "https://example.com" SeeAlso: referenceURL, externalReferenceURL
hidden	boolean	Yes	Whether the marker is concealed from the players. Note: Defaults to true — markers are the game master’s annotations until shared.
locked	boolean	Yes	Whether the marker is protected from being moved or edited on the map.
x	integer	Yes	The marker’s horizontal position in map coordinates.
y	integer	Yes	The marker’s vertical position in map coordinates.