HUD — Persistent Panels (YAML)

HUD panels (hud:) display persistent information on the player screen: HP, score, mini-map, countdown, and so on.

HUD panels are visible on web and desktop. On Discord and terminal they are ignored; essential information should also appear in narrative text.

Positions

top, bottom, left, right
top-left, top-right, bottom-left, bottom-right

Base Syntax

- id: fight_room
  hud:
    position: top-right
    text: |
      HP: v_hp_v / v_hpmax_v
      Score: v_score_v

events:
  - if: ~
    do: "hp.-.3"
    button: "Lose 3 HP"
    text: "Ouch!"
    hud:
      position: top-right
      text: "HP: v_hp_v / v_hpmax_v"

Size and Style

hud:
  position: top-right
  size: 38
  background: "#1a1a2e"
  text-color: "#e0e0ff"
  text: "Styled HUD"

Use width: and height: for explicit percentages.

Conditional Text

hud:
  position: top-right
  text:
    - if: "v_hp_v <= 0"
      text: "DEAD"
    - if: "v_hp_v <= 3"
      text: "CRITICAL! HP: v_hp_v"
    - text: "HP: v_hp_v / v_hpmax_v"

Split

split divides the panel into two zones.

hud:
  position: left
  width: 28
  text: |
    Current zone
    demo_split
    [[split]]
    HP: v_hp_v
    Score: v_score_v

Clear HUD

clear-hud:
  - all
  - top-right