Skip to content

Unity SDK Installation

The XRXP Unity SDK is maintained in the xrxp-unity repository.

Requirements

  • Unity 2021.3 LTS or later
  • access to the xrxp-unity repository
  • com.unity.textmeshpro for the core package
  • a running XRXP backend if you want online sync or live control

Install the core package

Option 1: Unity Package Manager from Git URL

In Unity:

  1. open Window > Package Manager
  2. click +
  3. choose Add package from git URL
  4. use:
https://github.com/pvaslin/xrxp-unity.git?path=/Packages/com.xrxp.core

Option 2: edit Packages/manifest.json

{
  "dependencies": {
    "com.xrxp.core": "https://github.com/pvaslin/xrxp-unity.git?path=/Packages/com.xrxp.core"
  }
}

Option 3: local package for development

{
  "dependencies": {
    "com.xrxp.core": "file:../xrxp-unity/Packages/com.xrxp.core"
  }
}

Install optional modules

All modules depend on com.xrxp.core.

Scene Controller

https://github.com/pvaslin/xrxp-unity.git?path=/Packages/com.xrxp.module.scenecontroller

FrameRate Monitor

https://github.com/pvaslin/xrxp-unity.git?path=/Packages/com.xrxp.module.framerate

Eye Tracking

https://github.com/pvaslin/xrxp-unity.git?path=/Packages/com.xrxp.module.eyetracking

First setup in Unity

After importing com.xrxp.core:

  1. run XRXP > Setup the scene
  2. select the generated Assets/XRXPConfig/XRXPConfig.asset
  3. fill in your experiment ID, token, and endpoints

This creates the base XRXP object and config asset used by the SDK.

  1. install com.xrxp.core
  2. verify one session can be recorded locally
  3. configure online endpoints
  4. add only the modules your experiment needs