hololens_app

iTeachLabeller Application for HoloLens 2 🦾

This repository contains the code for the iTeachLabeller application, developed specifically for HoloLens 2.

(i) The user interface flow of the iTeachLabeller app, from startup to the main menu.

(ii) Description of the main menu options in the iTeachLabeller app.

Setup Instructions ⚙️

To set up the required environment, please follow these steps:

1. Unity Hub: Download and install Unity Hub. 📥
2. Unity Engine: Obtain and install the Unity Engine. 🔧
3. Mixed Reality Toolkit (MRTK): Integrate the MRTK into your Unity project. 🌐
4. ROS Connector: Install the ROS TCP Connector. Be sure to review this issue. ⚠️
5. Visual Studio: Ensure Visual Studio is installed with the Universal Windows Platform feature enabled. 💻

For detailed setup instructions, refer to the how_to_build.md file in the IRVLUTD/HoloLens2ResearchTools repository. 📚

Building the Application 🏗️

Assuming the app's root directory is named iTeachLabellingApp, you can find guidance for building the app in the following video:

Compilation Steps with Screenshots 📸

• Build the project in Unity. 🔨
• Open the .sln file in Visual Studio. 📂
• Create the package. 📦
• Use the Windows Device Portal to install the .msix file. 🚀
• Record stream or manage the app (Open/Close/Uninstall) using the HoloLens portal. 📱

NOTE: Ensure to maintain a standalone system with a working Windows (Dev system + HoloLens), Unity, and Visual Studio to run simulations as well as for app building. We encountered difficulties where the same codebase successfully produced a build on one system but failed on another. To avoid issues, it is recommended to have a system where everything is version-maintained, and updates are done in a controlled manner. 🔒

Download Prebuilt Application 📥

If you prefer to use the application without any modifications, you can download the prebuilt version from the following link:

• Download iTeachLabeller.msix 📦 | App Install Video 🎥

⚠️ Note

• 🚨 It is recommended that a Windows device is used to compile this part of the project, and it has not been tested on other platforms.
• 💻 A Unity version newer or equivalent to a 2022 release and at least Microsoft Visual Studio 2022 are required.
• ⚙️ Due to technical constraints, this project can only run on a Hololens 2.