Global Options and Scenario Header (YAML)

Scenario Header

title: "My Scenario · v1.0 · (v_nbparties_o_v plays)"
description: |
  Free description shown in the scenario catalogue
  and in standalone export headers.
markdown: none

Avoid using | in the title; prefer · or a hyphen.

markdown:

Value	Rendering
`fix`	Monospace block.
`none`	Plain text.
`bold` / `italic` / `quote`	Global style.
`story`	Enables semantic story blocks.
`py` / `yaml` / `js` / …	Highlighted code block.

Global Text Style

size: 18
font: Georgia
background: "#111827"
text-color: "#f5f0d8"

options: Permanent Toolbar Buttons

options:
  refresh: "Refresh"
  inventory: "Bag"
  previous: "Back"
  v_score_v: "Score"
  home: "Home"

Key	Effect
`refresh`	Redisplay current room.
`inventory`	Show inventory.
`previous`	Go back to previous room.
`v_name_v`	Display variable value and description.
`room_id`	Direct access to a room.

External Links

options:
  url1: "https://cyril-fiesta.fr/jdr-bot-wiki/|Wiki"
  url2: "https://discord.gg/jdrbot|Discord"

Fallback Examine

If an option key points to an object or furniture name in the current room, the engine triggers examine on it instead of room navigation.

vars:, text_vars:, online_vars:

Variables declared at the root level, initialised when the game starts. See Variables.

global_events_order:

global_events_order: before

Accepted values: before or after. Default: after.

ui: - interface mode (v4.13)

Changes the game interface on the player side: cards, fullscreen, deck, phone. The key exists at scenario level and at room level, as does hide_input: which controls the command bar. Details on Interface modes.

ui: cards
hide_input: false

Phone mode adds two header keys: phone_home: (room of the Home button) and phone_shape: (portrait, landscape, tablet) - see Phone mode.

Direct launch URL

A scenario can be launched directly from a URL, without going through the home page:

https://jdr-bot.cyril-fiesta.fr/?play=scenarioname
https://jdr-bot.cyril-fiesta.fr/?play=scenarioname&lang=en

Automatic resolution: .yaml first, then .txt - no extension needed
Official scenarios/ folder only
&lang=en launches the English version directly (interface and catalogue included) - v4.13
Ideal for direct share links in announcements or presentation pages

show-type:

For drag & drop, show-type: true visually distinguishes source, target and mixed roles. The option can be defined at scenario level or only inside a room.

show-type: true

rooms:
  - id: workshop
    show-type: true
    text: "{{key:>key}} {{door:$door}}"