SGBasicDemo/README.md

# SGBasicDemo OpenXR

A basic OpenXR-compatible Blueprint demo demonstrating basic functionality such as grab/release, touch with buzz and force-feedback, etc using [the SenseGlove Unreal Engine Plugin](https://www.fab.com/listings/62bcdd2a-0bb1-4f34-b7b8-c5e7c9313099).

## Compatibility

This demo is based on the [SGBasicDemo](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal-SGBasicDemo) example scene. It has been upgraded to be compatible with the SenseGlove Unreal Engine Plugin `+v2.1.0`.

It's compatible with Unreal Engine `5.2+` and relies on the new experimental HMD-auto-detection for detecting the wrist tracker hardware. Thus, no more per HMD branches are provided. By default, all Android deployment settings have been configured to be compatible with Meta Quest devices (2, Pro, and 3).

__Please choose the correct branch for your desired engine version__:

- For UE `5.5+`: the __`master`__ branch.

### End-of-Life (EOL) Branches

The following branches and engine versions are no longer maintained and won't receive any kind of updates:

- __`5.4-eol`__ branch (UE `5.4`): which was supported up to `v2.7.3` release of the SenseGlove Unreal Engine Plugin.
- __`5.3-eol`__ branch (UE `5.3`): which was supported up to `v2.6.3` release of the SenseGlove Unreal Engine Plugin.
- __`5.2-eol`__ branch (UE `5.2`): which was supported up to `v2.4.2` release of the SenseGlove Unreal Engine Plugin. 

## Video Tutorials and Documentation

There is [a video tutorial on how to create this demo from scratch (originally created for Unreal Engine `5.2` and the SenseGlove Unreal Engine Plugin `v1.x.x`)](https://youtu.be/jN4VcfXVrTA) available on [the SenseGlove YouTube channel](https://www.youtube.com/@senseglove4021).

Over time, other relevant tutorials based on this demo have been released. The tutorials based on this demo are as follows (all of which, except the last one, were originally created for Unreal Engine `5.2` and the SenseGlove Unreal Engine Plugin `v1.x.x`):

- [Setting up Grabbing and Haptic Feedback functionalities (SGBasicDemo)](https://youtu.be/jN4VcfXVrTA)
- [Setting up VIVE Pro & VIVE Trackers in Unreal Engine](https://youtu.be/jvFDNdq_4xQ)
- [Setting up VIVE Focus 3 & VIVE Wrist Trackers in Unreal Engine](https://youtu.be/SGmQevkzsY4)
- [SGBasicDemo: setup throwing objects and physics settings for the real and virtual hands](https://youtu.be/K9Qr_LqgTcY)
- [SGBasicDemo v2: upgrading your projects to the SenseGlove Unreal Engine Plugin v2.0.0](https://youtu.be/VbWfoep-Hsg)

__NOTE__: We won't provide a video tutorial on how to upgrade the SGBasicDemo to `v2.1.x` version of the SenseGlove Unreal Engine Plugin, but [the SenseGlove Unreal Engine Handbook](https://unreal.docs.senseglove.com/) provides an [upgrade guide to `v2.1.x`](https://unreal.docs.senseglove.com/2.1/misc/upgrade-guide).

## 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.

__NOTE__: Unlike [the original SGBasicDemo](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal-SGBasicDemo) this repository is fully self-contained and ships a compatible version of the SenseGlove Unreal Engine Plugin with itself without relying on Git Submodules. So, once you download it using the kebab menu you can simply start using the project without the extra work of obtaining the plugin separately. So, no need to go through any of [Plugin Installation through the Epic Games Launcher](https://unreal.docs.senseglove.com/2.1/getting-started/installation/epic-games-launcher.html) or [Plugin Installation through Microsoft Azure DevOps Repositories](https://unreal.docs.senseglove.com/2.1/getting-started/installation/microsoft-azure-devops-repositories.html) processes.

## License

```
MIT License

Copyright (c) 2020 - 2025 SenseGlove

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```