Unity SDK Configuration¶

XRXP uses a ScriptableObject named XRXPConfig.

Main fields¶

The current config asset exposes these fields:

Field	Purpose
`ExperimentID`	Experiment identifier used to group recorded data
`AuthorizationToken`	Token used to authenticate with XRXP services
`WebSocketServer`	Live ingestion and exchange endpoint
`RESTServer`	REST API base URL
`FileServer`	File upload endpoint
`OnlineMode`	Enable server communication
`LocalStorageMode`	Keep data on the device
`BackUpStorageMode`	Enable extra backup storage

Recommended study configuration¶

For most deployments:

set ExperimentID to the target experiment
enable OnlineMode
enable LocalStorageMode (off by default, but strongly recommended for data durability)
keep BackUpStorageMode enabled when possible
use a service token created from the dashboard

LocalStorageMode defaults to off

The default value for LocalStorageMode is false. You must explicitly enable it to keep device-side copies of traces. Without it, data is only sent to the server and not stored locally on the device. For field studies and any scenario where network reliability matters, always enable LocalStorageMode.

Typical local values¶

ExperimentID: your-experiment-id
AuthorizationToken: your-token
WebSocketServer: ws://localhost:8081
RESTServer: http://localhost:8080
FileServer: http://localhost:8080
OnlineMode: true
LocalStorageMode: true
BackUpStorageMode: true

Where to get the values¶

Experiment ID: from the dashboard experiment list
Authorization token: from Admin > Service Tokens
Endpoints: from your self-hosted deployment or local stack

Important note about durability¶

If you care about data preservation during field work, do not rely on online mode alone.

Preferred mode:

local storage on
online mode on
stop sessions cleanly before shutdown