Prerequisites
1. Requirements
Before getting started, ensure your development environment meets the following requirements.
Supported Devices
Windows PC
Meta Quest Pro / 3
XREAL Air
Android Tablet (coming soon)
Apple Vision Pro
Unity Environment
Unity Hub installed
Unity Editor:
2022.3.X LTSor later6000.0.X LTSalso supported
Note: LTS (Long Term Support) versions are strongly recommended for maximum stability and compatibility.
Development Tool
Microsoft Visual Studio Code (or your preferred code editor)
2. Required Packages
Before starting the project, make sure the following packages and plugins are installed. These are essential for networking, XR features, UI, lobby systems, avatars, and motion support. If any package is missing, install it via Unity Package Manager or from its official source.
FishNet V4 - 4.6.12R (Core Networking)
XREAL XR Plugin - 3.0.0-pre.4 (for XREAL device support)
Master Server Toolkit - 4.22.0 (for server-client communication and room management)
XumLobby - 0.4.2 (for lobby creation and management)
XumNet - 0.3 (for RPC transport)
XR Interaction Toolkit - 3.1.2
OpenXR Plugin - 1.14.3 (cross-platform XR interface)
AR Foundation - 6.1.0 (for AR device support)
XR Hands - 1.5.1 (for hand tracking and visualization)
Unified XR Motion - 1.5.5 (for avatar motion across XR devices)
XRBuildKit - 1.2.3 (easy XR project build)
Text Mesh Pro (for high-quality UI text)
Newtonsoft-json - 3.2.1 (for JOSN parsing and serialization)
FishNet V4 (Core Networking)
Click ‘Open in Unity’ In the AssetStore, or visit FishNet GitHub.
In Unity Editor, go to Window > Package Management > Package Manager > My Assets
Click FishNet: Networking Evolved and Install
XREAL XR Plugin (for XREAL device support)
Download the XRAEL SDK for Unity
Import the XREAL SDK for Unity:
Go to
Window > Package Management > Package Manager > Install package from tarball...
Select
com.xreal.xr.tar.gzand click Install
After installation, import the samples:
Interaction Basics
Note:
Meta Quest devices are supported through the Unity XR Interaction Toolkit, eliminating the need for Meta's native SDKs.
This approach ensures broader compatibility and simplifies development across multiple XR devices, while still providing robust support for hand tracking, interaction, and input management on Meta Quest headsets.
Master Server Toolkit (for server-client communication and room management)
Download the master-server-toolkit repository from GitHub. You can either clone the repository or download it as a ZIP file:
git clone https://github.com/aevien/master-server-toolkit.gitOr via browser:
Click
Code>Download ZIPExtract the ZIP file to your local directory
Navigate to the downloaded folder:
master-server-toolkit/Assets/MasterServerToolkitCopy the entire MasterServerToolkit folder into your Unity project’s Assets folder:
YourUnityProject/Assets/So that the structure becomes:
YourUnityProject/Assets/MasterServerToolkitMake sure not to overwrite other existing folders unless you're intentionally upgrading.
XumLobby (for lobby creation and management)
Download XumLobby package from here
In Unity Editor, go to Assets > Import Package > Custom Package ...
Install the XumLobby package.
XumNet (network management)
Download XumNet package from here
In Unity Editor, go to Assets > Import Package > Custom Package ...
Install the XumNet package.
Go to Window > Package Management > Package Manager > Unity Registry
Search for XR Interaction Toolkit and click Install
After installation, import the samples:
Starter Assets
Hands Interaction Demo
visionOS (for Apple Vision Pro)
XR Device Simulator (optional)
OpenXR Plugin (cross-platform XR interface)
Go to Window > Package Management > Package Manager > Install package by name...
Type com.unity.xr.interaction.toolkit and click Install
AR Foundation (for AR device support)
Go to Window > Package Management > Package Manager > Unity Registry
Search for AR Foundation and click Install
XR Hands (for hand tracking and visualization)
Go to Window > Package Management > Package Manager > Unity Registry
Search for XR Hands and click Install
Import the HandVisualizer sample
Newtonsoft-json (for JOSN parsing and serialization)
Go to Window > Package Manager > + (Add) > Install package by name...
Type "com.unity.nuget.newtonsoft-json" in the Install package by name field, then click Install
Text Mesh Pro (with Examples & Extras; for high-quality UI text)
Go to Window > TextMeshPro > Import TMP Essential Resources
Unified XR Motion (consistent motion across XR devices)
Option1: Install from Local tarball (.tgz)
Download the com.kisti.unifiedxrmotion-1.4.0.tgz package file.
Go to
Window > Package Manager > + (Add) > Add package from tarball...Select the downloaded package file and click Install.
Option2: Install via GitHub URL with Token
Go to
Window > Package Manager > + (Add) > Add package from Git URL...Enter the URL using the following format:
https://{GitHub ID}:{PERSONAL_ACCESS_TOKEN}@github.com/oxr-sdk/UnifiedXRMotion.gitClick Install
Option3: Modify manifest.json Manually
Add the package reference like this(
Packages/manifest.json):
j {
"dependencies": {
"com.xreal.xr": "https://{GitHub ID}:{PERSONAL_ACCESS_TOKEN}@github.com/oxr-sdk/UnifiedXRMotion.git"
}
}Save the file. Unity will detect and install the package automatically.
XRBuildKit (easy XR project build/management)
Option1: Install from Local tarball (.tgz)
Download the XRBuildKit package file.
Go to
Window > Package Manager > + (Add) > Add package from tarball...Select the downloaded package file and click Install.
Option2: Install via GitHub URL with Token
Go to
Window > Package Manager > + (Add) > Add package from Git URL...Enter the URL using the following format:
https://{GitHub ID}:{PERSONAL_ACCESS_TOKEN}@github.com/oxr-sdk/XRBuildKit.gitClick Install
Option3: Modify manifest.json Manually
Add the package reference like this(
Packages/manifest.json):
{
"dependencies": {
"com.xreal.xr": "https://{GitHub ID}:{PERSONAL_ACCESS_TOKEN}@github.com/oxr-sdk/XRBuildKit.git"
}
}Save the file. Unity will detect and install the package automatically.
Re-import All Assets
After installing all packages, go to:
Assets > Reimport All to ensure proper import and linking of all dependencies.
Notes:
Install all samples for relevant packages, especially for XR Interaction Toolkit and XR Hands.
If you encounter missing packages or installation errors, refer to links above or:
Official Unity documentation
Asset Store pages
GitHub repositories (if applicable)
Last updated