Map pins
A pin marks a place too small to outline: a shop, a shrine, a cave
mouth. Linked to a location, it is that place on this map: the tavern's
pin on the town's map shows where the tavern is, and going into it moves
the scene to the tavern. A pin with no link is a plain labelled marker,
or an exit, such as a door or a stair (see exits). A
pin is a place or a way, never both: the tavern's front door is an exit
on the tavern's own map, not on its pin in the town. Pins and tokens are
both points on a map; a pin's kind is pin.
To add or change one, use the Pin tool (M).
Click the map, then link a location, create one, or choose "Skip — no link". Double-click a pin to go into its place's map.
Pin fields
id
The marker's own id, unique on this map.
| Field | Type | Required | Default | What it is |
|---|---|---|---|---|
id |
string |
yes |
kind
pin marks a place; token marks a character or creature.
| Field | Type | Required | Default | What it is |
|---|---|---|---|---|
kind |
"pin" | "token" |
"pin" |
pin for a place. Points left without a kind are pins.
label
The name shown on the map. Left out, the linked file's name is shown.
| Field | Type | Required | Default | What it is |
|---|---|---|---|---|
label |
string |
Name it as players will say it. The far side of a door is named for where it sits ("South Door", "Northeast Ladder"), never for where it leads.
fileReferenceId
The file it marks, by reference id: a location for a pin, a character for a token. Null for a plain marker.
| Field | Type | Required | Default | What it is |
|---|---|---|---|---|
fileReferenceId |
string | null |
Link the location the pin is. Leave it null for a plain marker or an exit: a pin with a link can't be an exit.
position
Where it sits on the map.
| Field | Type | Required | Default | What it is |
|---|---|---|---|---|
position |
{ x, y } |
yes | ||
position.x |
number |
yes | Across the map: 0 at the left edge, 1 at the right. | |
position.y |
number |
yes | Down the map: 0 at the top edge, 1 at the bottom. |
Put it where the place is in the map's picture, and check it there.
{ "position": { "x": 0.42, "y": 0.55 } }
style
The marker's color and icon.
| Field | Type | Required | Default | What it is |
|---|---|---|---|---|
style |
{ color, icon? } |
yes | ||
style.color |
string |
yes | The marker's color. | |
style.icon |
string | null |
An icon name, or null for none. |
{ "style": { "color": "#dc2626", "icon": null } }
locked
Locked in place, so it can't be dragged or removed by mistake.
| Field | Type | Required | Default | What it is |
|---|---|---|---|---|
locked |
boolean |
To set it, use the lock on the element's selection bar, or Lock element in its right-click menu.
exit
Makes it an exit, a way to another place: a door, stairs, a road out.
| Field | Type | Required | Default | What it is |
|---|---|---|---|---|
exit |
object |
Only on a pin with no link. To set it, use the Exit switch in the pin's or area's panel. Its fields are in exits.