Chapter 1: Start Here
| Guide | Scope | Formats |
|---|---|---|
| Features Overview | Product tour, capabilities, and links to related guides | Markdown · PDF |
| Quick Start | Installation and preparation for a first show, including style-pack handoff | Markdown · PDF |
| System Requirements | Hardware sizing, supported platforms, and setup expectations | Markdown · PDF |
| License & Activation | License tiers, trial, activation, and machine transfer | Markdown · PDF |
| Backup & Restore | Back up, restore, or move show data safely | Markdown · PDF |
| Keyboard Shortcuts | Keyboard shortcuts and live-show workflows | Markdown · PDF |
| Settings Tour | Settings panels without a dedicated manual | Markdown · PDF |
| Config & CLI | config.json, configuration locations, folders, and command-line flags |
Markdown · PDF |
Chapter 2: Audio, Visuals, And Show Control
| Guide | Scope | Formats |
|---|---|---|
| Audio Setup & Beat Sync | Audio devices and levels, silence detection, beat sources, and Ableton Link | Markdown · PDF |
| Visualizers | Audio-reactive visualizers, performance considerations, and event combinations | Markdown · PDF |
| Layers, Shaders & FX | Layer stack, shader chain, grading, and music-driven effects | Markdown · PDF |
| Lighting Layer | Spotlights, particles, strobes and controller shapes: settings, audio reaction, effects | Markdown · PDF |
| Touch Control | Touch-control view, editors, indicators, and window controls | Markdown · PDF |
| MIDI & HID Controllers | Hardware mapping, modifiers, visual feedback, and controller examples | Markdown · PDF |
| OSC Integration | OSC control from TouchOSC, DAWs, and Resolume over UDP | Markdown · PDF |
| Mobile Remote | QR pairing, mobile show control, and API keys | Markdown · PDF |
| Media Search & AI | Media search, AI services, and adding results to playlists | Markdown · PDF |
| Content Management | Artist profiles, branding, libraries, formats, and metadata | Markdown · PDF |
| Recording & Snapshots | Record the application window, capture images, and locate files | Markdown · PDF |
Chapter 3: Lighting, Output, And Automation
| Guide | Scope | Formats |
|---|---|---|
| DMX Rig Configuration | Fixture patching, movement, scenes, silence behavior, and diagnostics | Markdown · PDF |
| NDI & Spout Output | OBS, vMix, and Resolume routing, including multi-output layouts | Markdown · PDF |
| Multi-Screen & Client-Server | Driving multiple screens or rooms from one operator | Markdown · PDF |
| Programming Schedule | Clock-time automation and rehearsal controls | Markdown · PDF |
| Timecode Shows | MTC/LTC synchronization and position-based cues | Markdown · PDF |
Chapter 4: Integration And Supporting References
| Guide | Scope | Formats |
|---|---|---|
| MCP Server for Users | AI-assisted show control through MCP | Markdown · PDF |
| HTTP & WebSocket API | API integration tutorial: authentication, first calls and recipes | Markdown · PDF |
| API Reference (OpenAPI) | Every /api/v1 route, field, status code and WebSocket event, generated from openapi-api-v1.yaml |
YAML · PDF |
| Troubleshooting | First checks for common audio, visuals, DMX and integration problems | Markdown · PDF |
| User Manuals README | Manual-generation workflow, formats, and maintenance notes | Markdown · PDF |
Suggested reading paths
- First show: Features Overview → Quick Start → Keyboard Shortcuts → Audio Setup & Beat Sync.
- VJ workflow: Visualizers → Layers, Shaders & FX → Lighting Layer → MIDI & HID Controllers → NDI & Spout Output.
- Lighting workflow: DMX Rig Configuration → Programming Schedule or Timecode Shows → Mobile Remote.
- Integration: System Requirements → License & Activation → Multi-Screen & Client-Server → HTTP & WebSocket API or MCP.