diff --git a/README.md b/README.md index 63084f4..5022035 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,32 @@ WebViewStream is a Unity-based HoloLens 2 application for high-quality, low-late - **Hand menu and speech commands**: Offers an intuitive `HandMenu` and voice control for hands-free operation. - **Recording**: Allows streaming recording, with minor frame drops under high-load conditions. -## Installation +## Prerequisites -1. Clone the repository. -2. Configure the API host for [GetEndpoints](https://git.slc.ar/slococo-uni/getendpoints) to dynamically retrieve streaming endpoints. -3. Build and sideload the application to the HoloLens 2. +- Unity Hub +- Unity 2021.3.37f1 (LTS) with the following modules: + - Universal Windows Platform Build Support + - Windows Build Support (IL2CPP) +- Visual Studio 2022 with the following features (workloads): + - .NET desktop development + - Desktop Development with C++7 + - Universal Windows Platform development + - Game Development with Unity +- HoloLens 2 + +## Installation + +1. Clone the repository. +2. Open the project with Unity Hub. +3. Build the application. Make sure to build for UWP with the following configurations: + - Architecture: ARM 64-bit + - Build Type: D3D project + - Build Configuration: `Master` (if you are developing, you can choose `Debug` or `Release` instead). + Then, click **Build** and select a directory. Create a folder called `Build` within the project for better organization. If, for some reason, you get an error such as "IOException: Failed to move ... from ... to ...", you will likely need to exclude that folder from your antivirus. Exclude it and rebuild the project; it should work now. +4. Open the Visual Studio solution called `WebViewStream.sln`. It will be in the `Build` folder. +5. Connect the HoloLens via USB or Wi-Fi. Ensure [Developer Mode](https://learn.microsoft.com/en-us/windows/mixed-reality/develop/advanced-concepts/using-visual-studio?tabs=hl2#developer-mode-on-hololens) is enabled on the HoloLens. + - **USB**: Choose the following options at the top: `Master`, `ARM64`, and `Device`. Then click the `Device` button. + - **Wi-Fi**: Choose `Remote Machine`, then click on the `WebViewStream Debug Properties` by selecting the arrow on the right of the button. Next, click `Debugging`, and under `Machine Name`, enter the HoloLens IP, for example: `192.168.150.4`. Exit the menu and click the `Remote Machine` button. ## Technical details