Outils pour utilisateurs

Outils du site


en:yaml:alias

Language / Langue : FR | EN

Aliases and Commands (YAML)

Aliases let the player navigate or interact by typing a short keyword, without knowing the exact room id or action name.

Command in a choice

command: in a choice defines the keyword the player can type to take that exit.

choices:
  - command: north
    button: "⬆️ Go north"
    to: north_forest

  - command: back
    to: home

Without command:, the room is still reachable via its id (go north_forest), but not via a custom shortcut.

Global aliases

global_aliases: maps a command to a reusable button label available in every room. Useful for recurring buttons (back, inventory, help…).

global_aliases:
  back: "🏠 Home"
  help: "❓ Help"

In any room, a choice with command: back automatically inherits the label 🏠 Home without repeating button: everywhere:

choices:
  - command: back
    to: home      # displays "🏠 Home" from global_aliases

Action alias

In actions:, alias: creates a shortcut: the player can type the word alone instead of the full verb target pair.

actions:
  - verb: inspect
    target: still
    alias: still
    if: ~
    text_ok: "The still awaits your ingredients."

The player can type still instead of inspect still.

global_aliases: can also point to a room to make it accessible from everywhere:

global_aliases:
  map: "🗺️ View map"

rooms:
  - id: world_map
    ...
  - id: corridor
    choices:
      - command: map
        to: world_map    # "map" available from every room

See also

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