diff --git a/README.md b/README.md index 6b097f0..4d24147 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,29 @@ A sample project demonstrating how to integrate the SenseGlove Unreal Engine Plu This demo is compatible with UE `5.4`. -For a MetaXR-compatible version switch to the `metaxr` branch and for a ViveOpenXR-compatible version switch to the `viveopenxr` branch. +**IMPORTANT NOTE**: This repository contains multiple branches, each configured for specific combinations of HMDs, wrist-tracking hardware, and plugins. Not all configurations are supported in this demo. Below is a breakdown of the available branches and their configurations: + +- `pcvr-quest`: + - PCVR Mode + - Quest 3 Controller + - Epic OpenXR Plugin +
+- `pcvr-vive`: + - PCVR Mode + - VIVE Focus 3 Wrist Tracker + - Epic OpenXR and OpenXRViveTracker Plugins +
+- `standalone-quest`: + - Standalone Mode (Android) + - Quest 3 Controller + - Epic OpenXR Plugin +
+- `standalone-vive`: + - Standalone Mode (Android) + - VIVE Focus 3 Wrist Tracker + - HTC ViveOpenXR Plugin + +To adjust the wrist-tracking settings for your specific hardware, please refer to the [official documentation](https://unreal.docs.senseglove.com/next/getting-started/setup-wrist-tracking-hardware/). ## How to checkout