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

# Introduction

> What is the xRLive SDK and what can you build with it

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

<CardGroup cols={2}>
  <Card title="Alert System" icon="bell" href="/sdk/alert/overview">
    Show styled alerts (Info, Warning, Success, Error) from anywhere in your project with a single Blueprint node.
  </Card>

  <Card title="Actor Management" icon="cube" href="/sdk/actors/overview">
    Spawn and register actors, Niagara effects, and Material Parameter Collections for automatic cleanup when your visual closes.
  </Card>

  <Card title="Window Sync" icon="display" href="/sdk/window-sync/overview">
    Keep the operator viewport in sync with the game window size in real time — no file polling, no lag.
  </Card>

  <Card title="UI Components" icon="sliders" href="/sdk/ui-components/overview">
    Ready-made operator controls: sliders, buttons, dropdowns, checkboxes, text inputs, and color pickers — all driven by JSON.
  </Card>
</CardGroup>

## 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.

<Info>
  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.
</Info>

## Platforms

| Platform | Status    |
| -------- | --------- |
| Windows  | Shipping  |
| Mac      | Supported |