Skip to content

Kurzz Tutorial

Kurzz is a playable music activity inside the larger Rally scenario. The player is a new drummer who arrived before they fully understood the situation. Their job is to keep time, read the room, and decide when a song is still a song.

These tutorials are for the people writing the scenarios those players play through.

Who This Is For

Content authors and scripting contributors working on Kurzz scenario files.

You will write YAML specs and Lua scripts. You will not touch Rust engine code.

If you are working on the engine itself -- pop dynamics, jazz forge, voice pipeline -- start from the plans in docs/plans/ inside the plantangenet engine repo, and from the crate documentation there.

Tutorial Steps

Step File What You Build
1 01_lets_pop.md Pop spec: tempo, chord loop, sections, arc, axes, rules, tutorial cue field
2 02_stuck_note_incident.md Stuck Note incident: Lua script, progress tracking, event contract, Walker feedback

Work through the steps in order. Step 2 adds fields to the file you create in Step 1.

What These Tutorials Cover

  • Authoring a simulation.pop YAML spec from scratch
  • Choosing tempo and chord shapes for tutorial legibility
  • Wiring pop guidance fields (tutorial_cue) to Walker UI cues
  • Defining an incident in spec + Lua script
  • The event contract between Lua scripts and Walker panels

What These Tutorials Do Not Cover

  • Rust engine internals (pop dynamics, jazz forge, voice synthesis)
  • Walker panel development -- see docs/PANEL-DEVELOPMENT-GUIDE.md in the walker repo
  • Ren scenes and cutscene scripting -- deferred; tracked in the plan
  • Quest objective wiring -- deferred; tracked in the plan

References

  • `plantangenet/music/docs/MUSIC_IN_PLANTANGENET.md -- How "music" works in plantangeent.
  • plantangenet/music/docs/NEW_POP.md -- How to Develop a new pop
  • scenarios/kurzz/docs/plans/PLAN-kurzz-human-workflow.md -- design spec and phase tracking
  • scenarios/PLAN-scripting-engines.md -- scripting engine architecture (JtlHost, Lua/Rhai)
  • scenarios/kurzz/docs/A_new_drummer.md -- lore and voice reference for the Kurzz scenario
  • Walker repo: docs/PANEL-DEVELOPMENT-GUIDE.md -- how to build a display panel