# Lumora.live

> Documentation

All you need to know about operating HTML graphics on Lumora.live

## Table of Contents

### Overview

- [What is Lumora?](/overview/about.md): What Lumora.live is: a browser-based CG system where you upload OGraf or Lottie templates, drive them from a web control panel, and capture the output in OBS, vMix, or casparCG.
- [Quickstart](/overview/quickstart.md): A ten-minute walkthrough from a fresh Lumora account to a graphic on-air: sign up, create a workspace, upload a template, and take it live.
- [The desktop Controller](/overview/controller.md): Install and use the Lumora Controller desktop app on Windows: sign-in, choosing a workspace, local data files, tally, the Client API, preview screenshots, pop-outs, logs and reporting problems.
- [How to get help](/overview/help.md): Where to get help with Lumora.live: the community Discord, email support, bug reporting, status and incidents, and feature requests.
- [Frequently asked questions](/faq.md): Short answers to the questions new Lumora operators ask most often, each linking to the full documentation page.

### Operating Lumora

- [Outputs](/operating/outputs.md): How Lumora outputs work: create output channels, capture each output URL in your broadcast software, and identify which channel is which.
- [The graphics rundown](/operating/rundown.md): How to organise graphics into rundowns in Lumora: toggle between graphics and rundown views, create, rename, duplicate, and delete rundowns, and set accent colours.
- [The graphic control form](/operating/control-form.md): How the graphic control form works in Lumora: forms are generated from the template's controllable fields, layouts can be customised, and graphics can be updated while on air.
- [Data sources](/operating/data-sources.md): Pull values into Lumora graphics from Google Sheets, CSV, JSON, or XLSX data sources: setup, polling, size limits, and binding cells to control form fields.
- [Automation & Channel lock](/operating/automation-channel-lock.md): Per-graphic Automation and Channel lock settings in Lumora: time a graphic out automatically, chain the next graphic in the rundown, and pin a graphic to specific output channels.
- [Hotkeys](/operating/hotkeys.md): Keyboard shortcuts for live operation in the Lumora control panel: graphics navigation, take and take-off, output channel switching, and emergency clear.
- [Performance](/operating/performance.md): How to get a faithful graphic preview and smooth live operation in Lumora: browser extensions, the control panel, the Controller App, and output renderers.
- [The multiview](/operating/multiview.md): Documentation for the Lumora multiview is being reworked and will be published in a future update.

### Templates

- [Templates overview](/templates/overview.md): Templates versus graphics in Lumora: how reusable template designs and the graphics created from them relate, and where each lives in the UI.
- [Uploading a template](/templates/upload.md): How to upload templates to a Lumora workspace: OGraf bundles as .zip or folder, and Lottie animations as .json or .lottie files.
- [Template Library](/templates/library.md): The Lumora Template Library: browse free and paid pre-built broadcast graphics templates, add them to your account, and enable them per workspace.
- [Build graphics with AI](/skills/install.md): Install the lumora-ograf skill so AI assistants such as Claude Code, Codex and Cursor can build, preview and package OGraf graphics for Lumora.

### Advanced Configuration

- [Server API](/advanced/server-api.md): Lumora's Server API: trigger graphics over HTTP from Stream Deck, Companion, or automation scripts using a workspace API key. Covers endpoints, parameters, examples, and rate limits.
- [Client API](/advanced/client-api.md): The Lumora Controller's local Client API: trigger hotkey-equivalent actions and query app state from local tools over HTTP, with no API key required.
- [Data API](/advanced/data-api.md): Lumora's Data API: push live JSON into a workspace and bind nested fields onto graphics for low-latency feeds like esports stats and score tickers.
- [Tally](/advanced/tally.md): Connect Lumora to your vision mixer for tally: set up vMix, Blackmagic ATEM, TSL 3.1 and Panasonic KAIROS in the desktop Controller and map each output to a mixer input.

### Account & workspaces

- [Account management](/account/account.md): Managing your Lumora account: sign-up and email verification, login and password reset, email changes, and GDPR account deletion.
- [Workspaces](/account/workspaces.md): Lumora workspaces: the workspace concept, creating a workspace, workspace settings, member management, and deleting a workspace.

### Billing

- [Subscription plans](/billing/subscription-plans.md): Lumora subscription plans compared: the free trial, per-tier features and caps, and Free workspace limitations.
- [Subscription management](/billing/subscription-management.md): Managing a Lumora workspace subscription: upgrading, cancelling, resuming, locked workspace behaviour, and how Paddle billing appears on your statement.

### Other

- [Untitled](/advanced.md): Advanced Lumora configuration: the Server API, Client API, Data API and tally.