/MixedReality-Unreal-Samples

A collection of mixed reality samples built with Unreal Engine 4

Primary LanguageC++MIT LicenseMIT

Unreal Samples

This repository hosts sample applications for mixed reality projects on Unreal Engine 4. (https://docs.microsoft.com/en-us/windows/mixed-reality/unreal-development-overview)

  • The HoloLens2Example project is a simple app that allows you to spawn Paragon minions on the surface of your world and store their locations with persistent anchors
  • The Chess App is the final result of the Unreal + UX Tools tutorial located on the Microsoft Mixed Reality docs

HoloLens 2 Example App

This is a simple HoloLens 2 app built with Unreal Engine 4.24 that demonstrates:

  • Basic articulated hand tracking-based interactions in the form of fingertip cursor and pushable buttons
  • Spatial mapping and collision understanding
  • Launching, saving and loading persistent anchors in the world

How to build and deploy the app

Make sure you have Unreal Engine 4.24 or later installed on your computer.

How to use the app

Press the "Spawn" button to bring up the launch pin. The launch pin is steered by head gaze, aiming at a horizontal planar surface will allow you to airtap to place a character anchor. Pressing "Save Pins" will store the anchors to the device. Pressing "Clear Pins" will delete the anchor information stored on device (but will not remove current live anchors). If the app is closed and/or reset, pressing "Load Pins" will restore the saved characters and anchors.

On the Emulator, you can also use key presses to trigger the buttons. Make sure you uncheck "Use keyboard for simulation" in the simulation control panel first. Press 1 for "Spawn", 2 for "Save Pins", 3 for "Clear Pins", and 4 for "Load Pins".

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.