Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Concepts

These pages explain how brink works — the mental model behind the API, not a how-to. Read them once and the guides and reference will make more sense; skip them and you can still get a story running, you just won’t know why.

  • The Two Pipelines — why there’s a native compiler and a converter, and which one you want.
  • The Execution Model — how a compiled story runs: the Program/Story split, the step loop, Line, and choices. The shared foundation every client (raw Rust, Bevy, web) builds on.
  • Architecture & the Firewall — how the crates are split so the runtime never links the compiler.
  • The Compilation Pipeline — the six phases that turn .ink source into bytecode.