Outils pour utilisateurs

Outils du site


en:yaml:export

Language / Langue : FR | EN

YAML - Multiple files, standalone and PDF export

Splitting a scenario into several YAML files

A large scenario may be split across several files. In the editor's room list, select a global category or a room, then use Split after selection. A separator can be moved or removed like other entries in the list.

On export, the editor automatically creates:

scenario.yaml
scenario.1.yaml
scenario.2.yaml

The main file receives Nombre_yaml: 3. Do not build this series by hand: the editor places cuts between complete sections and keeps comments preceding a new section with that section.

Several fragments are downloaded in one ZIP. They may also be extracted into a folder named after the scenario. Open a folder loads the whole series at once. Numbered fragments are not separate playable scenarios.

A folder may also contain the scenario's images and notes. The engine looks for its ZIP first, then its main YAML and finally its TXT; unrelated files are ignored.

HTML5 standalone export

File > Export HTML5 standalone creates a complete game ZIP which needs no installation and can be hosted on itch.io or any Web server.

The ZIP contains index.html, the runtime in app/ and compiled scenario data in data/.

  • no JDR-Bot server is required;
  • game saves, achievements and _p variables use local storage;
  • online _o variables become local to that standalone;
  • local media is bundled whenever possible;
  • external media remains available through its URL.

Scenario achievements are always included. Include compatible global achievements is disabled by default and only adds global achievements which can be earned inside a standalone game.

A later JDR-Bot update does not alter an already exported ZIP. Export it again to include standalone runtime fixes.

PDF gamebook export

File > Export PDF gamebook creates a gamebook with numbered chapters, references, endings, appendices and a tracking sheet. It contains internal links and remains playable when printed.

Sharing on itch.io

  1. Export the scenario as an HTML5 standalone.
  2. Create an itch.io project of type HTML.
  3. Upload the ZIP directly.
  4. Select it as the main file.
  5. Tick This file will be played in the browser.

See also

en/yaml/export.txt · Dernière modification : de cyrilfiesta