Skip to content

Install the Unity SDK

This page gets XRXP into your Unity project with the minimum setup needed to start recording useful data.

Outcome

When you finish this page, you will have:

  • the XRXP core package installed
  • an XRXP object created in your scene
  • a ready-to-fill XRXPConfig asset

1. Install the core package

Open Unity Package Manager and add this Git URL:

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

2. Generate the XRXP scene setup

In Unity, run:

XRXP > Setup the scene

This creates:

  • an XRXP GameObject in the current scene
  • an XRXPConfig asset in Assets/XRXPConfig/

3. Fill the essential configuration

At minimum, prepare these fields:

  • ExperimentID
  • AuthorizationToken
  • WebSocketServer
  • RESTServer
  • FileServer
  • OnlineMode
  • LocalStorageMode

Recommended default for real studies:

  • keep OnlineMode enabled
  • keep LocalStorageMode enabled
  • keep backup storage enabled when available

4. Add optional modules only when they solve a real need

Module Scene Controller Remote scene changes and facilitator-driven flows. Open module guide Module FrameRate Monitor Detect FPS drops and performance instability during a session. Open module guide Module Eye Tracking Capture gaze and look-area data on supported hardware. Open module guide

Next step

Now validate the install by sending a real session:

Need more detail?