Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

xRLive Documentation home page

Support
Dashboard
Dashboard

Support

Getting Started

Introduction
Installation
Visual Lifecycle

Build Your First Visual

Overview
Project Setup
Plugin & Scene Setup
Define the Control List
Wire Action Controller
Test in the Editor

Alert System

Alert System
Show xRLive Alert

Actor Management

Actor Management
Spawn Visual Actor
Register Visual Actor
Register Visual Effect
Register MPC for Reset

Window Sync

Window Sync
Publish Game Window Size

UI Components

UI Components
Slider
Button
Checkbox
Dropdown
Text Input
Color Picker
JSON Schema

Audio Reactivity

Audio Reactivity Overview
Beat Data JSON Format
Wiring Controls to Audio

Audience Interaction

Audience Interaction Overview
Firebase Sync
Runtime Client Credentials
Audience Web Frontend

OSC

OSC Overview
Sending OSC
Receiving OSC
Preset Triggers

Utilities

Request Camera Permission
Camera Settings
List Network Interfaces

Publishing

Export a .xrlive Pak
Upload to Marketplace
Review Process
Versioning & Patches

Best Practices

Performance
Cross-Platform
Visual Isolation

Runtime API

Runtime API Overview
Authenticate
Start Event
Join Event
End Event
Record Usage

Audience Interaction

Audience Web Frontend

How the audience-facing mobile web page connects to your visual

This page is coming soon. Full documentation will be available here shortly.

Runtime Client Credentials

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform