Documentation

How to run a service with this thing, how it works underneath, and how to host it yourself.

New here? Getting started walks through a first show end to end. If you are about to run something that matters, Operating is the one to read.

• Getting started

  Your first show, from opening the page to text moving on a screen.

• Operating

  The manual: the script, scrolling, screens, clocks, messages, the controller.

• Keyboard & controller

  Every command, with its keys and its gamepad button.

• Themes

  Writing your own viewer layout in plain CSS.

• Architecture

  How the pieces fit: signalling, peer topology, what crosses the wire.

• Self-hosting

  Docker, TLS, TURN, and why HTTPS is worth having.

• Development

  The build, the gates, and how to check a change is real.

• Roadmap

  Open decisions, what is wanted next, ideas.

These pages are mirrored from the project's own documentation, which lives in the repository. Spotted something wrong? Open an issue.