Skip to content

Getting started

Follow these pages in order if you are new to Story authoring:

  1. Installation
  2. Core concepts
  3. Quick start

That path gets you from a clean machine to a working Hello World without sending you into the generated reference or the implementation-facing Specs too early.

Current support

  • Runtime: Windows x64 or Windows ARM64
  • SDK/tooling: .NET 10
  • Story schema: v1beta1
  • Optional Canvas host: GitHub Copilot App with the separate rune-story extension

What you will learn

The getting-started sequence teaches:

  • how to install or restore the story CLI,
  • what a Story, canvas, script, Action, Sprite, token, and wait mean,
  • how to build the canonical hello-rune.story.yaml a few lines at a time, and
  • which guide to read next for animation, layout, media, theming, or export tasks.

After the first successful run

Use the task guides when you are ready to go beyond Hello World:

Then browse the Examples gallery to move from Hello World into motion, composition, visual systems, presentation, and media using checked-in Stories.

Keep Reference nearby when you need exact command, field, Spec, or release coverage.

Rune Project brings Rune Story authoring together with the Rune Engine rendering foundation.