| title | description | author | ms.author | ms.date | ms.topic | ms.localizationpriority | keywords |
|---|---|---|---|---|---|---|---|
Setting up your Unreal project |
Learn how to set up your project wit the latest version of Unreal Engine and the Mixed Reality Feature Tool. |
hferrone |
v-hferrone |
4/28/2021 |
tutorial |
high |
Unreal, Unreal Engine 4, UE4, HoloLens 2, mixed reality, development, features, new project, emulator, documentation, guides, holograms, game development, mixed reality headset, windows mixed reality headset, virtual reality headset, up-to-date, tools, get started, basics, unreal, toolkit, hub, installation, Windows, HoloLens, openxr, mrtk |
We recommend installing Unreal Engine version 4.25 or later to take full advantage of built-in HoloLens support.
Go to the Library tab in the Epic Games Launcher, select the dropdown arrow next to Launch and click Options. Under Target Platforms, select HoloLens 2 and click Apply.
Mixed Reality Toolkit (MRTK) is an open-source, cross-platform development kit for mixed reality applications. MRTK provides a cross-platform input system, foundational components, and common building blocks for spatial interactions. The toolkit is intended to accelerate the development of applications targeting Microsoft HoloLens, Windows Mixed Reality immersive (VR) headsets, and the OpenVR platform.
If you don't already have a mixed reality project, follow the first three sections of the HoloLens 2 Getting Started tutorials to get a project ready for the MRTK.
We recommend that you use the MRTK Hub to acquire MRTK plugins. It's a new way for developers to discover and update Microsoft Mixed Reality plugins and add them to their Unreal projects. You can view plugins, see their dependencies and install them into your project without leaving the Unreal Editor.
- Discover new Microsoft Mixed Reality plugins and install them and their dependencies into your Unreal project.
- Keep your Microsoft Mixed Reality plugins up to date.
- Remove Microsoft Mixed Reality plugins from your project if you no longer need them.
Note
The MRTK Hub for Unreal is only available for Unreal Engine version 4.26 or later. For Unreal Engine version 4.25, you can get MRTK plugins from the Unreal Engine Marketplace or GitHub as described in the Getting Started section.
Download the plugin from the Unreal Engine Marketplace, then open your project, and then enable the plugin from the Mixed Reality section of the Plugins menu. When prompted, restart the editor.
Once the plugin is enabled for your project, you can access the Hub from the toolbar button.
To install a plugin using the Hub, select the plugin you want to add to your project and then press the Install button. To download the plugin, verify that there are no conflicts in the Issues box and press Confirm. Once the plugin is downloaded, you'll be prompted to restart the editor. Unfortunately we can't auto-restart the editor for you; sometimes the new editor instance will start before the installation is complete.
After closing the editor you'll see a command prompt appear with a progress bar for unpacking the downloaded plugin. One command prompt will appear for each plugin being installed. Once unpacking is completed, you can re-open the editor and continue on your mixed reality development journey.
Important
Once the plugin is installed, it must be checked into source control like any other project-level plugin.
To update a plugin using the Hub, select the plugin you want to update from the list and press the Install button. To download the updated plugin, verify that there are no conflicts in the Issues box and press Confirm. You'll be prompted to restart the editor to complete the update. Plugin updates are done during editor startup so there's no need to wait for any unpacking to complete before you re-open the editor.
To uninstall a plugin using the Hub, select the plugin you want to remove, and then select the version you have installed from the dropdown. To remove the plugin, verify that there are no conflicts in the Issues box and press Confirm. You'll be prompted to restart the editor to complete the removal.
You can view the exact changes that will be made to your project in the bottom section of the Hub's window. From here you can see the plugins that will be added or removed from your project alongside any potential incompatibilities that might cause issues when the changes have been made.
Note
The Issues list will surface incompatibilities in the Unreal engine version and plugin dependency versions but it doesn't automatically fix or suggest fixes to issues.
:::row:::
:::column:::
Mixed Reality Toolkit-Unreal (GitHub)
:::column-end:::
:::row-end:::
Note
If you don't want to use MRTK for Unreal, you'll need to script all interactions and behaviors yourself.