← All documentation

Canonwell guide

Canonwell Markdown

Write a readable session chapter and use explicit directives for facts Canonwell should remember.

Start a session

Start every document with YAML front matter containing arcstate: 1 and a title. Add campaignId when the destination is known; otherwise choose the destination in the importer.

Normal Markdown becomes the chapter. Directives are fenced blocks such as :::roll … :::. Parsing is deterministic: Canonwell never uses AI to infer facts from prose.

Use directives

Use scene, player, roll, oracle, discovery, consequence, thread, challenge, entity, and closing directives. Only directives create structured events.

Updates require exact IDs. Canonwell never guesses a thread or entity from a similar display name. Preview errors include a useful line number and must be resolved before import.