SGVRETemplateDemo/README.md

# SenseGlove VRExpansion Plugin Integration Demo

A sample project demonstrating how to integrate the SenseGlove Unreal Engine Plugin into third-party OpenXR plugins such as the [VRExpansionPlugin](https://github.com/mordentral/VRExpansionPlugin).

## Compatibility

This demo is compatible with UE `5.4`.

**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
<br />
- `pcvr-vive`:
    - PCVR Mode
    - VIVE Focus 3 Wrist Tracker
    - Epic OpenXR and OpenXRViveTracker Plugins
<br />
- `standalone-quest`:
    - Standalone Mode (Android)
    - Quest 3 Controller
    - Epic OpenXR Plugin
<br />
- `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/2.4/getting-started/setup-wrist-tracking-hardware/).

## How to checkout

The most straightforward way to download this project is to click on the kebab menu (three vertical dots) located at the top-right of the screen and choose Download as Zip to obtain the source code for that branch or tag.

This repository is fully self-contained and ships a compatible version of the SenseGlove Unreal Engine Plugin with itself along with any third-party plugin that is required. So, once you download it using the kebab menu you can simply start using the project without the extra work of obtaining any plugins separately.

## License

Checkout the [LICENSE.md](./LICENSE.md) file for the usage license of this project, the SenseGlove Unreal Engine Plugin or any third-party plugins that are shipped through this repository.