id: my-scenario
language: en
title: "My scenario"
description: |
  Description shown in the catalogue and standalone export.
category: fiction
scenario_tags: [adventure, humour]
markdown: none

id: identifies the scenario permanently. It is required when using achievements or persistent ''_p'' variables. A translation keeps the same ID when it should share progress.

language: is fr or en. The official scenarios/ and scripts/ folders already determine their language without opening every file, but this key is useful for imported scenarios and custom hosting.

category: accepts fiction, escape-game, tutoriel, exemple or divers. scenario_tags: is a free list used by statistics and global achievements.

Do not put | in the title: it is used as a separator in catalogue entries.

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

These values are the default for Web and Desktop text. Individual rooms may override them.

options:
  refresh: "Refresh"
  inventory: "Inventory"
  previous: "Previous"
  v_score_v: "Score"
  home: "Home"
  url1: "https://cyril-fiesta.fr/jdr-bot-wiki/|Wiki"

If a key points to an object or piece of furniture in the current room instead of a room, JDR-Bot automatically examines it.

vars: contains numbers and text_vars: contains text. The _p and _o suffixes determine persistence. online_vars: remains compatible but is no longer recommended. See Variables.

Global events are checked after local events by default. To check them first:

global_events_order: before

Accepted values are before and after.

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

The engine looks for a folder with that name first, then a YAML file and finally a TXT file. lang=en selects the English catalogue.

ui: selects cards, fullscreen, deck or phone. It works at scenario or room level, as does hide_input:. See Interface modes.

ui: cards
hide_input: false

Phone mode adds phone_home: and phone_shape:. See Phone mode.

For drag and drop, show-type: true distinguishes source, target and mixed elements. It may be set globally or for one room.

Public links use the scenario's title and description. If its description is missing, the description in liste_scenarios.txt is used as a fallback.

Catalogue tags, declared in liste_scenarios.txt, can be freely chosen: they appear on cards and are included in searches. Known tags keep their translations and tabs. They are separate from room tags, which add behaviour to the scenario.

command_echo: false

Echo is disabled by default. true shows commands and button clicks in the game log. A room can override the global setting.

shortcuts: lists are available at the root and in rooms: see Keyboard, mouse and gamepad. Phone mode adds phone_auto_orientation:: see Phone orientation.