Reference#

This page is generated from the code and must not be edited by hand.

The reference is the part of the documentation that is a fact about the engine. It is generated from the code, so it cannot say anything the engine does not do: when a rule, a word, a setting or a command changes, these pages change with it.

Page

What it holds

Rules and Dictionary words

Every rule and every Dictionary word as a list or as cards, by pack, with text to copy into your own pack or project.

Command line

Every command and option, with its default.

Rules

The 115 rules in the shipped Rulebook, in plain words, with what each may be tuned by and what would defeat it.

Dictionary

Every word the engine knows, by section of the core and by pack, with what each can mean.

Record schemas

What the engine writes, and the eight relations.

Settings

Every key a project’s settings file may hold.

Dashboard API

Every route the Dashboard asks the engine for.