GM instructions format
Each entry below is read from the schema that checks every save, so the field names, types and descriptions are exactly what a save accepts. The same shape holds a world's instructions and a game's own copy.
The Game Master place writes this for you. You see it when you export the instructions as JSON from the ⋯ menu, or import a file there.
The format
The whole value
A world's or a game's GM instructions as they are saved: its own instructions, its sections, its player options, and what it changed of Craft's defaults. null means only Craft's defaults.
| Field | Type | Required | What it is |
|---|---|---|---|
instructions |
({ platform, section? } | object)[] |
yes | The world's own instructions, in every game whatever is picked. An entry such as { "platform": "combat-tracker" } only places one of Craft's among them. |
sections |
string[] |
The names of the world's sections, in the order the GM reads them, empty ones included. | |
options |
({ key, platform } | object)[] |
yes | The world's player options, in the order players see them. An entry such as { "key": "platform-response-length", "platform": true } only places one of Craft's among them. |
platform |
{ instructions?, options? } |
What the world changed of Craft's defaults. Left out when it changed nothing. |
{
"sections": ["World", "Rules"],
"instructions": [
{
"name": "Premise",
"when": "always",
"section": "World",
"body": "The Hollow Coast, forty years after the sea rose…"
}
],
"options": [],
"platform": { "instructions": { "travel-times": { "off": true } } }
}
null, or no value at all, means the world kept only Craft's defaults.
To start your own, write an object with empty instructions and
options lists.
The world's instructions are read in section order: those with no
section first, then each section's in the order sections lists them.
Craft's defaults sit in "Narration" and "Rules": use those
sections where they fit.
An instruction
One rule for the GM: always on, situational, or a procedure. The same shape is used for the world's own instructions and a choice's.
| Field | Type | Required | What it is |
|---|---|---|---|
name |
string |
Its title, the heading the GM reads it under. Needed on an always-on instruction or a procedure of the world's own; under a choice an untitled one takes its option's name (pick one, on/off) or its choice's (pick any). A situational one without a title goes by its trigger. | |
body |
string |
yes | What the GM is told: the rule, or a procedure's steps, or a tracker's rules. Its limit depends on its kind. |
when |
"always" | "situational" | "procedure" |
yes | Its kind. "always": in the GM's prompt on every turn. "situational": handed to the GM only on turns its trigger comes up. "procedure": listed by title and trigger, read whole when its moment comes. |
trigger |
string |
Required on a situational instruction (the moment it is for) and on a procedure (when to use it). Starts with "When…", at most 120 characters. | |
pruning |
"after-use" | "on-compaction" |
A procedure's only: how long what the GM read of it stays. Left out or "after-use": until the turn ends. "on-compaction": until the game's memory is next compacted, for a procedure that runs over several turns. | |
section |
string |
The section a world instruction sits in. Left out, it sits above every section. A choice's instructions have none. | |
tracker |
object |
A tracker this instruction defines for the current state. Its body is then the tracker's rules, read beside the tracker while it is in play, not in the prompt. |
{
"when": "situational",
"trigger": "When a character drops to 0 HP",
"section": "Rules",
"body": "They fall unconscious and make a death save at the start of each of their turns: roll 2d6, and 7 or higher is a success. Three successes and they stabilize; three failures and they die."
}
Which fields it needs depends on its kind:
| Kind | Needs | Text up to |
|---|---|---|
"always" |
name (in the world's own list), body |
2,000 |
"situational" |
trigger, body |
1,000 |
"procedure" |
name (in the world's own list), trigger, body; never a tracker |
10,000 |
With a tracker, the instruction is the tracker's rules. Give it the
tracker's name as name, "always" as when and no section
(trackers are listed apart); its text is up to
2,000 characters, and it can't be a
procedure. It doesn't
count toward the always-on budget. Every field of the tracker is in
Trackers.
Instructions have no ids. Nothing points at one, so they can be moved, retitled and reordered freely.
A player option
A question the player answers when a game starts ("Difficulty"), whose choices each bring their own instructions.
| Field | Type | Required | What it is |
|---|---|---|---|
key |
string |
yes | What a game's picks point at. Lowercase letters, digits and hyphens, unique among the options. Never change it once games exist. |
label |
string |
yes | The option's name, as players see it ("Difficulty"). |
description |
string |
yes | The question players see under the name. Can be empty. |
kind |
"one" | "several" | "toggle" |
yes | How players pick. "one": exactly one choice. "several": any number, or none. "toggle": on or off, with exactly one choice. |
default |
string[] |
yes | The choice keys a new game starts with. Exactly one for a pick-one option; none or its one choice for an on/off option. |
choices |
({ key, label, description, instructions })[] |
yes | Its choices, in the order players see them. |
{
"key": "salvage",
"label": "Salvage",
"description": "How hard it is to find what the crew needs.",
"kind": "one",
"default": ["scarce"],
"choices": [
{
"key": "scarce",
"label": "Scarce",
"description": "Every find is a fight.",
"instructions": [
{
"when": "always",
"body": "Useful salvage is rare. A good find is the point of a whole scene, and someone else always wants it."
}
]
},
{
"key": "plentiful",
"label": "Plentiful",
"description": "More treasure, less hunger.",
"instructions": []
}
]
}
Each option is one question at game start. A game has at most 9 options, Craft's 2 included, and each at most 8 choices.
When a game's pick names a choice the option no longer has, or the option is new since the game started, the game plays that option's default.
A choice
One answer to a player option, with the instructions it brings while picked.
| Field | Type | Required | What it is |
|---|---|---|---|
key |
string |
yes | What a game's picks point at. Lowercase letters, digits and hyphens, unique in its option. Never change it once games exist. |
label |
string |
yes | The choice's name, as players see it. |
description |
string |
yes | A line players see under the name. Can be empty. |
instructions |
object[] |
yes | The instructions this choice brings, in play only while it is picked. Empty brings nothing. |
{
"key": "brutal",
"label": "Brutal",
"description": "Fights are deadly.",
"instructions": [
{
"when": "always",
"body": "Enemies fight to win. A character at 0 HP is dead unless someone reaches them this round."
}
]
}
An untitled instruction under a choice takes its title from where it lives: a pick-one or on/off option's instructions take the option's name (its choices are versions of one rule), a pick-any option's take the choice's name (each choice is its own rule). Consecutive instructions with the same title read as one rule under one heading.
A choice's tracker is used only in games that pick it. With the key of one of the world's trackers, it replaces that tracker in those games.
Changes to Craft's defaults
What the world changed of Craft's default instructions and player options. One it left alone has no entry, so Craft's improvements keep reaching it.
| Field | Type | Required | What it is |
|---|---|---|---|
instructions |
Record<string, { off } | object> |
Craft's instructions this world changed, by id: { "off": true } to remove one, or the world's whole version of it with basedOn. | |
options |
Record<string, { off } | object> |
Craft's player options this world changed, by key: { "off": true } to remove one, or the world's whole version of it with basedOn. |
{
"instructions": {
"travel-times": { "off": true },
"player-character": {
"name": "Player agency",
"when": "always",
"section": "Narration",
"body": "…the world's version of Craft's text…",
"basedOn": 2
}
},
"options": { "platform-long-distance-travel": { "off": true } }
}
Write a change to one of Craft's defaults here, never as a copy among the world's own. How to reword, remove and place them is in Craft's defaults.