Welcome to Lumio Docs
Lumio is a multi-platform streaming management application for Twitch, YouTube, Kick, Trovo, Discord, and Spotify.
What is Lumio?
Lumio gives streamers a single dashboard for overlays, chat, bots, music, events, and automations across every connected platform:
- Multi-platform connections — Channel connections for Twitch, YouTube, Kick, Trovo and Spotify; Discord as a login and bot/integration platform
- Overlay editor — Visual layer-based overlay editor with live preview; every overlay renders as an OBS browser source
- Widgets & extensions — 12 system extensions (8 widgets + 4 bot modules) plus third-party extensions from the Extension Store
- Event system — Real-time events (follows, subs, cheers, raids, redemptions, tips) with filtering, alerts and history
- Multichat — Unified chat across all connected platforms with cross-platform moderation
- Chat bots — Five bots (Twitch, YouTube, Kick, Trovo, Discord) sharing one command system
- Spotify integration — Playback control from the dashboard plus a Now Playing overlay widget
- Automations — Node-based workflow editor wiring triggers to conditions and actions
- RBAC — Fine-grained role-based access control for team management
Platform at a glance
Lumio is a Rust + TypeScript monorepo: 33 Rust crates (lo-*), 16 apps, 9 internal TypeScript packages (@lumio/*), 5 public npm packages (@zaflun/*), and 12 system extensions (8 widgets + 4 bot modules).
The API is an Actix Web service that exposes every feature over three protocols simultaneously:
| Surface | Endpoint |
|---|---|
| GraphQL (primary) | POST /v1/gql |
| GraphiQL IDE | GET /v1/graphiql |
| GraphQL SDL | GET /v1/schema |
| REST | everything under /v1/ |
| WebSocket | /v1/ws |
Data lives in PostgreSQL (relational data), TimescaleDB (time-series: events, chat, audit logs) and Redis (cache and pub/sub).
Production runs on lumio.vision (dashboard), id.lumio.vision (login), api.lumio.vision (API), admin.lumio.vision (admin), overlay.lumio.vision (overlays) and widget.lumio.vision (widgets).
Quick Links
- Installation — Set up a local development environment
- OAuth Provider Setup — Create the OAuth applications Lumio needs
- Connecting Platforms — Link your streaming accounts
- First Overlay — Create your first overlay and add it to OBS
- API Reference — REST, GraphQL and WebSocket documentation
- Developer Guide — Build custom bot modules