Mixed Reality Toolkit

Introduction

UX Tools for Unreal Engine is a UE game plugin with code, blueprints and example assets created to help you add in features commonly needed when you're developing UX for mixed reality applications. The project is still in early development (it provides a small set of features and breaking changes are to be expected) but the current features are complete and robust enough to use in your own projects.

Note

Only HoloLens 2 development is supported at the moment.

The current features include:

  • Input simulation - Simulates articulated hands and head pose that you can use in-editor. This is great for improving development iteration times.
  • Hand interaction actor - Used to interact with our UX components with articulated hands.
  • Pressable button component - Low level component used to drive the state of button blueprints. An example button blueprint is provided.
  • Manipulator component - Allows moving and rotating an actor with either one or two hand manipulation.
  • Follow behaviour component - Keeps an actor or component within sight of another component, usually the camera.

Included but still in development is a bounding box component that allows manipulation of an actor's transform via affordances.

Features

Getting Started

  1. Download UE 4.25.1 or later. Earlier versions are not supported.
  2. Clone this repository.
  3. Checkout public/0.8.x.
    • Bear in mind that this branch is alive. It's not a release, and will be updated regularly with potentially breaking changes. There will be a release tag (e.g. release/0.8.0) marked as such in GitHub.

It's a good idea to have a look at the example maps provided in the UX Tools Game (/UXToolsGame) to get familiar with how the plugin works.

To use the plugin in a game:

  1. Copy the UXTools folder in /UXToolsGame/Plugins/ to your game's Plugins directory.

    • Make sure the game project is a code one (not a BluePrint-only game) in order to be able to build the plugin sources.

  2. Open the game project and enable the UX Tools plugin in the plugins menu.

You can find a complete setup guide in the MRTK Getting Started tutorial series.

To make sure everything is working as expected, add a hand interaction actor and an instance of the simple button blueprint to a level and try pressing the button with the simulated hands when playing in the editor.

Documentation

The latest version of the documentation can be found here.

Feedback and Contributions

Due to the early stage of the project and the likelihood of internal refactors, we are not in a position to accept external contributions through pull requests at this time. However, contributions and feedback in the shape of bug reports, suggestions and feature requests are always welcome!