diff --git a/README.md b/README.md index 04629ca05be00fcdd14c4376afa9eaed80fc906d..60649409cc7fc4ec2f375b588fa21b27fcae8b96 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,8 @@ # Welcome to Reality Stack I/O -Reality Stack I/O (RSIO) is an intermediate layer that implements native manufacturer SDKs and the OpenXR standard. RSIO supports head, controller, hand, and eye tracking, as well as passthrough capabilities. It addresses the challenges of cross-device and cross-platform compatibility, allowing researchers and developers to focus on creating XR experiences rather than managing system integration. RSIO consists of several Unity packages to support different XR devices, with examples demonstrating the framework's capabilities. +Reality Stack I/O (RSIO) is an intermediate layer that implements native manufacturer SDKs and the OpenXR standard. RSIO is free and open source, licensed under the [MIT License](LICENSE.md). -RSIO is free and open source, licensed under the [MIT-License](LICENSE.md). - -# Scientific Reference - -If you use RSIO for scientific work, please cite the following [publication](https://doi.org/10.1109/ISMAR-Adjunct60411.2023.00023): - -BibTex reference: - -````latex -@INPROCEEDINGS{10322199, - author={Kern, Florian and Latoschik, Marc Erich}, - booktitle={2023 IEEE International Symposium on Mixed and Augmented Reality Adjunct (ISMAR-Adjunct)}, - title={Reality Stack I/O: A Versatile and Modular Framework for Simplifying and Unifying XR Applications and Research}, - year={2023}, - volume={}, - number={}, - pages={74-76}, - doi={10.1109/ISMAR-Adjunct60411.2023.00023}} -```` - -# Contact - -If you have any questions, feel free to contact us at [realitystack@uni-wuerzburg.de](mailto:realitystack@uni-wuerzburg.de) - -University of Wuerzburg<br> -Chair for Human-Computer Interaction<br> -Prof. Dr. Marc Erich Latoschik<br> -[https://hci.uni-wuerzburg.de/](https://hci.uni-wuerzburg.de/) - -University of Wuerzburg<br> -Group of Psychologie Intelligenter Interaktiver Systeme<br> -Prof. Dr. Carolin Wienrich<br> -[https://www.mcm.uni-wuerzburg.de/piis/](https://www.mcm.uni-wuerzburg.de/piis/) - -# Supported Unity Environments - -RSIO was developed with Unity 2022.3.52f1 for Windows and Android platforms. We use the Universal Render Pipeline (URP). - -# Quick Start - -- Install Unity 2022.3 with Android support -- Create a Universal 3D Core project with Unity 2022.3 or use clone our sample project -- Open `Preferences -> External Tools` and check `Git packages` -- `Project Settings -> Player -> ActiveInputHandling` and select `Both` -- Open `Project Settings -> Player` and select the third horizontal tab `Android` - - Change `Graphics API` to `OpenGLES3` and disable `Auto Graphics API` - - Uncheck `Override Default Package Name`, and enter a package name - - Select `IL2CPP` - - Select `ARM64` -- Open the `Assets/Packages` folder -- Clone the `UnityExtensions` repository -- Clone the `io-base` repository -- Clone this repository and follow the instructions below +Please check out the [Reality Stack Base package](https://gitlab2.informatik.uni-wuerzburg.de/hci-development/realitystack/realitystack-io-base) for a quick start guide and more information # Pico Package @@ -67,19 +15,19 @@ This package supports the following devices: | Pico 4 | PICO | x | x | x | x | | x | | | x | | | Pico 4 Enterprise | PICO | x | x | x | x | x | x | | | x | | -Please follow these steps to setup this package: +Please follow these steps to set up this package: -- The `io-pico` package depends on `com.unity.xr.picoxr`, which is not available in the Unity AssetStore. -- We provide a customized package called `io-pico-integration-sdk`. -- We provide a customized package of the `com.unity.xr.picoxr` (`o-pico-integration-sdk`) including a modified version of the `PXR_SDKSettingEditor.cs` script, that normally tries to enable OpenXR features with a popup window each update. -- Locate the `Project Folder View`. -- Open `Runtime -> Prefabs` and copy the `PicoPlugin` to the scene and disable other plugins . -- Open `Project Settings -> XR Plug-in Management` and enable the `PICO` XR plugin in the Android tab. -- Configure the `DeviceConfiguration` in `Assets/Resources` according to your needs. +- The `io-pico` package depends on `com.unity.xr.picoxr`, which is not available in the Unity Asset Store +- We provide a customized package called `io-pico-integration-sdk` +- We provide a customized package of the `com.unity.xr.picoxr` (`o-pico-integration-sdk`) including a modified version of the `PXR_SDKSettingEditor.cs` script, that normally tries to enable OpenXR features with a popup window each update +- Locate the `Project Folder View` +- Open `Runtime -> Prefabs` and copy the `PicoPlugin` to the scene and disable other plugins +- Open `Project Settings -> XR Plug-in Management` and enable the `PICO` XR plugin in the Android tab +- Configure the `DeviceConfiguration` in `Assets/Resources` according to your needs - Open `Assets/Resources` and configure `PXR_ProjectSetting`. - Check `Hand Tracking`. - Check `Eye Tracking`. - Check `Eyetracking Calibration`. - - Check `Video See Through`. -- A valid `AndroidManifest.xml` file is copied automatically to `Assets/Plugins/Android`. -- Open `PXR_Build -> Platform settings` and enter a PXR build id (e.g., `1234`) in the context menu to prevent NullReferenceExceptions. \ No newline at end of file + - Check `Video See Through` + - A valid `AndroidManifest.xml` file is copied automatically to `Assets/Plugins/Android` + - Open `PXR_Build -> Platform settings` and enter a PXR build id (e.g., `1234`) in the context menu to prevent NullReferenceExceptions. \ No newline at end of file