Skip to content

Unity SDK Overview

The XRXP Unity SDK is the client side of the platform.

It is responsible for:

  • creating and closing sessions
  • recording events, questions, statistics, media, and tracked transforms
  • saving traces on the device
  • streaming data to XRXP when online
  • exposing optional modules for scene control, frame-rate monitoring, and eye tracking

Package layout

The Unity repository is split into one core package and optional modules:

  • com.xrxp.core
  • com.xrxp.module.scenecontroller
  • com.xrxp.module.framerate
  • com.xrxp.module.eyetracking
Step 1 Install the SDK Add the core package to your Unity project via Package Manager or Git URL. Installation Step 2 Configure XRXPConfig Set experiment ID, endpoints, tokens, and storage preferences. Configuration Step 3 Understand the data model Users, sessions, environments, events, systems, and how they relate. Data model Step 4 Record a session Start sessions, log events, capture media, and flush traces. Recording sessions Step 5 Add tracking Track objects, body parts, and sensor data with internal systems. Tracking data Step 6 Enable exchange or modules Add live status, remote control, and optional modules for your needs. Exchange and modules

Design model

The SDK is intentionally modular:

  • the core package works on its own
  • each optional module adds a focused capability
  • module setup happens through Unity menu entries under XRXP or XRXP/Modules