Learn Rune Story

Use this curriculum in order. It starts with a working install, teaches the small set of ideas you need to read a Story, then moves into task-focused guides that stay close to the checked-in samples.

1. Install and verify the CLI

• Installation covers the supported environment, global and repo-local installs, and the contributor source-build path.
• Getting started shows the full path through the first run.

2. Learn the core vocabulary

Read Core concepts before you start copying YAML. It introduces:

• a Story document,
• the canvas coordinate space,
• the ordered script of Actions,
• named Sprites,
• literal values and reusable tokens, and
• wait, which makes timing explicit instead of guessed.

3. Build Hello World in small steps

Quick start walks through the canonical samples/story/quick-start.story.yaml in short snippets:

1. define the Story header and canvas,
2. create a background and text sprites,
3. animate a card with set + spring,
4. sequence the result with wait: settle, and
5. preview or export the exact same file.

4. Move into task guides

After the first successful run, keep the generated reference open and pick the guide that matches the job you are doing:

• Story authoring workflow
• Animation and timing
• Layout and cameras
• Composition and reuse
• Media and TTS
• Design system
• Preview, live, and export

5. Learn by example

Browse the progressive gallery after the first Story works. Start with Hello Rune and settle timing, then move through motion, composition, visual systems, presentation, video, and narration. Every featured page pairs a real rendered frame with the matching checked-in source.

6. Use Reference when you need exact coverage

• Story CLI reference
• Story syntax reference
• Developer Specs
• Release and compatibility notes

The Learn curriculum explains workflows. Reference stays authoritative for commands, fields, developer contracts, and versioned compatibility.