Content Directory Structure

This directory organizes downbeat scenario content by type.

area/

Entrance area specifications. Each file is a simulation.area YAML spec.

Example: entrance.yml, antechamber.yml

Reference: tutorial/TUTORIAL-areas.md

region/

Geographic containment regions. Each file is a simulation.region YAML spec.

Example: lobby.yml

Reference: tutorial/TUTORIAL-regions.md

creatures/

NPC definitions. Each file is a simulation.npc YAML spec.

Example: herald.yml, concierge.yml, ensemble.yml

ren/

Cutscenes and narrative moments. Each file is a simulation.ren YAML spec.

Example: entrance_greeting.yml, entrance_tutorial.yml

ren_triggers/

Trigger definitions that fire ren scenes or scripts. Each file is a simulation.ren_trigger YAML spec.

Example: start_entrance_choreography.yml

quests/

Quest definitions (optional for downbeat; may add later). Each file is a simulation.quest YAML spec.

Example: complete_entrance.yml (quest to experience entrance)

scripts/

Choreography and logic scripts (Rhai format).

Example: entrance_choreography.rhai — NPC arrival/exit sequencing

Reading Order

When adding content:

1. Define areas in area/
2. Define region in region/ (references areas)
3. Define NPCs in creatures/
4. Define narrative in ren/
5. Define choreography in scripts/
6. Define triggers in ren_triggers/ (links scripts to events)

See the tutorial for detailed walkthroughs.