# xRLive Documentation

## Docs

- [Invoices](https://xrlive.mintlify.app/dashboard/billing/invoices.md): View and download your billing history
- [Manage Subscription](https://xrlive.mintlify.app/dashboard/billing/manage-subscription.md): Update, pause, or cancel your subscription via Stripe
- [Plans & Subscriptions](https://xrlive.mintlify.app/dashboard/billing/plans.md): Compare xRLive subscription plans and choose the right one
- [Subscribe](https://xrlive.mintlify.app/dashboard/billing/subscribe.md): Upgrade to PRO or CREATOR
- [My Visuals](https://xrlive.mintlify.app/dashboard/creator/my-visuals.md): Upload, manage, and publish your xRLive visuals
- [Payouts](https://xrlive.mintlify.app/dashboard/creator/payouts.md): Set up Stripe Connect and manage your payout settings
- [Runtime Clients](https://xrlive.mintlify.app/dashboard/creator/runtime-clients.md): Generate and manage Client ID and Secret Key credentials for your visual
- [Sales](https://xrlive.mintlify.app/dashboard/creator/sales.md): Track revenue and performance for your published visuals
- [Browse the Marketplace](https://xrlive.mintlify.app/dashboard/marketplace/browse.md): Find and preview visuals from the xRLive creator community
- [Buy a Visual](https://xrlive.mintlify.app/dashboard/marketplace/buy-a-visual.md): Purchase a visual and add it to your library
- [My Library](https://xrlive.mintlify.app/dashboard/marketplace/my-library.md): Access and manage all your purchased and owned visuals
- [Notifications](https://xrlive.mintlify.app/dashboard/notifications.md): View and manage your xRLive notifications
- [Profile](https://xrlive.mintlify.app/dashboard/profile.md): Manage your account details and password
- [Sign In](https://xrlive.mintlify.app/dashboard/signin.md): Log in to the xRLive dashboard
- [Sign Up](https://xrlive.mintlify.app/dashboard/signup.md): Create an xRLive account with email or Google
- [Welcome to xRLive](https://xrlive.mintlify.app/index.md): Run real-time 3D visuals, audience interactions, and live game shows from a single dashboard
- [Game Shows](https://xrlive.mintlify.app/launcher/audience/game-shows.md): Run full game show experiences with scoring and rounds
- [Audience Interaction Overview](https://xrlive.mintlify.app/launcher/audience/overview.md): How the xRLive audience layer works
- [Polls & Votes](https://xrlive.mintlify.app/launcher/audience/polls-and-votes.md): Run live polls and let the audience influence the visual
- [QR Code & Joining](https://xrlive.mintlify.app/launcher/audience/qr-join.md): Let your audience join a session from their phone
- [Audio Setup](https://xrlive.mintlify.app/launcher/devices/audio.md): Route audio input for reactivity and monitoring
- [Camera Setup](https://xrlive.mintlify.app/launcher/devices/camera.md): Connect and configure camera capture devices
- [Network Setup](https://xrlive.mintlify.app/launcher/devices/network-setup.md): Configure network adapters and connectivity for xRLive
- [First Launch](https://xrlive.mintlify.app/launcher/install/first-launch.md): Log in, configure your display, and get set up on first run
- [Install on Mac](https://xrlive.mintlify.app/launcher/install/mac.md): Download and install the xRLive Launcher on macOS
- [System Requirements](https://xrlive.mintlify.app/launcher/install/system-requirements.md): Minimum and recommended hardware specs for running xRLive
- [Install on Windows](https://xrlive.mintlify.app/launcher/install/windows.md): Download and install the xRLive Launcher on Windows
- [OSC Integration](https://xrlive.mintlify.app/launcher/output/osc-integration.md): Control xRLive from external show-control systems via OSC
- [Render to File](https://xrlive.mintlify.app/launcher/output/render-to-file.md): Export the visual output to PNG, JPG, MOV, or AVI (Windows)
- [Show Control](https://xrlive.mintlify.app/launcher/output/show-control.md): Connect xRLive to hardware and show-control consoles
- [Launcher Troubleshooting](https://xrlive.mintlify.app/launcher/troubleshooting.md): Diagnose and fix common launcher issues on Windows and Mac
- [Launcher Interface](https://xrlive.mintlify.app/launcher/ui/overview.md): Tour of the operator dashboard and game window layout
- [Preferences](https://xrlive.mintlify.app/launcher/ui/preferences.md): App preferences, audio routing, and general settings
- [Window Settings](https://xrlive.mintlify.app/launcher/ui/window-settings.md): Fullscreen, windowed mode, display selection, and resolution
- [Audio Reactivity](https://xrlive.mintlify.app/launcher/visuals/audio-reactivity.md): Set controls to react to the beat of your audio feed
- [Visual Library](https://xrlive.mintlify.app/launcher/visuals/library.md): Browse and manage your owned visuals
- [Open a Visual](https://xrlive.mintlify.app/launcher/visuals/open-a-visual.md): Load a visual from your library and launch the game window
- [Operator Controls](https://xrlive.mintlify.app/launcher/visuals/operator-controls.md): Use sliders, buttons, color pickers, dropdowns, and checkboxes live on stage
- [Presets](https://xrlive.mintlify.app/launcher/visuals/presets.md): Save, load, and trigger presets during a show
- [Core Concepts](https://xrlive.mintlify.app/overview/concepts.md): Glossary of key terms used throughout xRLive
- [FAQ](https://xrlive.mintlify.app/overview/faq.md): Answers to common questions about xRLive
- [Quick Start](https://xrlive.mintlify.app/overview/quickstart.md): Go from zero to running your first visual in 10 minutes
- [Plans & Subscriptions](https://xrlive.mintlify.app/overview/subscriptions.md): Compare FREE, PRO, and CREATOR plans
- [Support](https://xrlive.mintlify.app/overview/support.md): How to get help, report bugs, and reach the xRLive team
- [Troubleshooting](https://xrlive.mintlify.app/overview/troubleshooting.md): Solutions to common problems across the platform
- [What is xRLive](https://xrlive.mintlify.app/overview/what-is-xrlive.md): Understand the platform — visuals, the launcher, the dashboard, and the audience layer
- [Actor Management](https://xrlive.mintlify.app/sdk/actors/overview.md): Automatically clean up runtime-spawned actors, effects, and MPC changes when your visual closes
- [Register MPC for Reset](https://xrlive.mintlify.app/sdk/actors/register-mpc-for-reset.md): Reset a Material Parameter Collection to its defaults when the visual closes
- [Register Visual Actor](https://xrlive.mintlify.app/sdk/actors/register-visual-actor.md): Register an existing actor for automatic cleanup
- [Register Visual Effect](https://xrlive.mintlify.app/sdk/actors/register-visual-effect.md): Register a Niagara component for automatic cleanup
- [Spawn Visual Actor](https://xrlive.mintlify.app/sdk/actors/spawn-visual-actor.md): Spawn an actor and automatically register it for cleanup
- [Alert System](https://xrlive.mintlify.app/sdk/alert/overview.md): Show styled alerts from anywhere in your visual
- [Show xRLive Alert](https://xrlive.mintlify.app/sdk/alert/show-alert.md): Display a styled alert in the operator window
- [Firebase Sync](https://xrlive.mintlify.app/sdk/audience/firebase-sync.md): Receive real-time audience data via Firebase Realtime Database
- [Audience Interaction Overview](https://xrlive.mintlify.app/sdk/audience/overview.md): Connect your visual to live audience data
- [Runtime Client Credentials](https://xrlive.mintlify.app/sdk/audience/runtime-client-credentials.md): How to create and embed the credentials your visual needs to call the xRLive backend
- [Audience Web Frontend](https://xrlive.mintlify.app/sdk/audience/web-frontend.md): How the audience-facing mobile web page connects to your visual
- [Beat Data JSON Format](https://xrlive.mintlify.app/sdk/audio/json-format.md): The JSON schema xRLive uses to deliver audio beat data
- [Audio Reactivity Overview](https://xrlive.mintlify.app/sdk/audio/overview.md): How beat data drives controls in real time
- [Wiring Controls to Audio](https://xrlive.mintlify.app/sdk/audio/wiring-controls.md): Configure sliders and color pickers to react to beats
- [Cross-Platform](https://xrlive.mintlify.app/sdk/best-practices/cross-platform.md): Ship visuals that run correctly on both Windows and Mac
- [Performance](https://xrlive.mintlify.app/sdk/best-practices/performance.md): Optimize your visual for smooth live-event performance
- [Visual Isolation](https://xrlive.mintlify.app/sdk/best-practices/visual-isolation.md): Ensure actors, effects, and state are fully cleaned up between visuals
- [Build Your First Visual](https://xrlive.mintlify.app/sdk/build-your-first-visual.md): Step-by-step tutorial to create and run a minimal xRLive visual
- [Installation](https://xrlive.mintlify.app/sdk/installation.md): Add the xRLive SDK plugin to your Unreal Engine project
- [Introduction](https://xrlive.mintlify.app/sdk/introduction.md): What is the xRLive SDK and what can you build with it
- [OSC Overview](https://xrlive.mintlify.app/sdk/osc/overview.md): Use OSC to control xRLive from external hardware and software
- [Preset Triggers](https://xrlive.mintlify.app/sdk/osc/preset-triggers.md): Trigger operator presets via OSC commands
- [Receiving OSC](https://xrlive.mintlify.app/sdk/osc/receiving.md): Receive OSC messages and drive visual parameters
- [Sending OSC](https://xrlive.mintlify.app/sdk/osc/sending.md): Send OSC messages from your visual to external systems
- [Export a .xrlive Pak](https://xrlive.mintlify.app/sdk/publishing/export-xrlive-pak.md): Package your visual as a .xrlive file using the SDK
- [Review Process](https://xrlive.mintlify.app/sdk/publishing/review-process.md): What happens after you submit — the moderation workflow
- [Upload to Marketplace](https://xrlive.mintlify.app/sdk/publishing/upload-to-marketplace.md): Submit your visual to the xRLive Marketplace
- [Versioning & Patches](https://xrlive.mintlify.app/sdk/publishing/versioning-and-patches.md): Release updates and patches for published visuals
- [Authenticate](https://xrlive.mintlify.app/sdk/runtime-api/authenticate.md): Exchange your clientId and clientSecret for a short-lived access token
- [End Event](https://xrlive.mintlify.app/sdk/runtime-api/end-event.md): Close the active session when the show ends
- [Join Event](https://xrlive.mintlify.app/sdk/runtime-api/join-event.md): Register an audience member into the active session and receive their attendee token
- [Runtime API Overview](https://xrlive.mintlify.app/sdk/runtime-api/overview.md): How your visual authenticates and manages live event sessions via the xRLive backend
- [Record Usage](https://xrlive.mintlify.app/sdk/runtime-api/record-usage.md): Push custom metrics to the backend during an active event
- [Start Event](https://xrlive.mintlify.app/sdk/runtime-api/start-event.md): Open a live session for your visual on the xRLive backend
- [Button](https://xrlive.mintlify.app/sdk/ui-components/button.md): Trigger a one-shot event from the operator panel
- [Checkbox](https://xrlive.mintlify.app/sdk/ui-components/checkbox.md): Boolean toggle exposed to the operator
- [Color Picker](https://xrlive.mintlify.app/sdk/ui-components/color-picker.md): HSV color picker with per-channel audio reactivity support
- [Dropdown](https://xrlive.mintlify.app/sdk/ui-components/dropdown.md): Select from a list of named string options
- [JSON Schema](https://xrlive.mintlify.app/sdk/ui-components/json-schema.md): Full configuration schema reference for all UI components
- [UI Components](https://xrlive.mintlify.app/sdk/ui-components/overview.md): Operator-facing controls driven by JSON configuration
- [Slider](https://xrlive.mintlify.app/sdk/ui-components/slider.md): Float control with min/max range and optional audio reactivity
- [Text Input](https://xrlive.mintlify.app/sdk/ui-components/text-input.md): Free-text field for operator-entered strings
- [Request Camera Permission](https://xrlive.mintlify.app/sdk/utilities/camera-permission.md): Ask the OS for camera access before enumerating capture devices
- [Camera Settings](https://xrlive.mintlify.app/sdk/utilities/camera-settings.md): Control field of view and depth-of-field on the xRLive camera from the component Details panel or at runtime via Blueprint
- [List Network Interfaces](https://xrlive.mintlify.app/sdk/utilities/network-interfaces.md): Get all active network adapters with their IP addresses
- [Visual Lifecycle](https://xrlive.mintlify.app/sdk/visual-lifecycle.md): How the xRLive Launcher loads, runs, and unloads your visual
- [Window Sync](https://xrlive.mintlify.app/sdk/window-sync/overview.md): Keep the operator viewport in sync with the game window size
- [Publish Game Window Size](https://xrlive.mintlify.app/sdk/window-sync/publish-game-window-size.md): Broadcast the current game window size to the operator viewport

## OpenAPI Specs

- [openapi](https://xrlive.mintlify.app/api-reference/openapi.json)

## Optional

- [Support](mailto:admin@xrlive.tv)