**Language / Langue :** [[fr:yaml:options|FR]] | **EN**

====== Global Options and Scenario Header (YAML) ======

===== Scenario Header =====

<code yaml>
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
</code>

Avoid using ''|'' in the title; prefer ''·'' or ''—''.

===== 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 =====

<code yaml>
size: 18
font: Georgia
background: "#111827"
text-color: "#f5f0d8"
</code>

===== options: Permanent Toolbar Buttons =====

<code yaml>
options:
  refresh: "Refresh"
  inventory: "Bag"
  previous: "Back"
  v_score_v: "Score"
  home: "Home"
</code>

^ 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 =====

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

===== 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.

===== global_events_order: =====

<code yaml>
global_events_order: before
</code>

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 [[en:ui:presentation|Interface modes]].

<code yaml>
ui: cards
hide_input: false
</code>

Phone mode adds two header keys: ''phone_home:'' (room of the Home button) and ''phone_shape:'' (portrait, landscape, tablet) - see [[en:ui:phone|Phone mode]].

===== Direct launch URL =====

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

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

  * 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 [[en:yaml:drag-drop|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.

<code yaml>
show-type: true

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