Skip to main content

Documentation Index

Fetch the complete documentation index at: https://xrlive.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The xRLive SDK is an Unreal Engine plugin that lets developers create interactive visuals for live events. Visuals are packaged as .xrlive files and loaded at runtime by the xRLive Launcher without restarting the application.

What the SDK provides

Alert System

Show styled alerts (Info, Warning, Success, Error) from anywhere in your project with a single Blueprint node.

Actor Management

Spawn and register actors, Niagara effects, and Material Parameter Collections for automatic cleanup when your visual closes.

Window Sync

Keep the operator viewport in sync with the game window size in real time — no file polling, no lag.

UI Components

Ready-made operator controls: sliders, buttons, dropdowns, checkboxes, text inputs, and color pickers — all driven by JSON.

How visuals work

A visual is a standard Unreal Engine project packaged as a .xrlive pak file. The xRLive Launcher mounts the pak at runtime, loads the visual’s map, and manages the lifecycle — including cleanup when the operator switches to a different visual.
Both the operator (dashboard) window and the game window run inside the same Unreal Engine process. This means Blueprint nodes, subsystems, and delegates work across both windows with no IPC needed.

Platforms

PlatformStatus
WindowsShipping
MacSupported