Getting started with MRTK and XR SDK
Caution
We've moved!
See this page on the new docs website. We've moved so we can provide you with a better docs experience. We will no longer be maintaing documentation on Github. Check out the new site to get started with MRTK in Unity!
XR SDK is Unity's new XR pipeline in Unity 2019.3 and beyond. In Unity 2019, it provides an alternative to the existing XR pipeline. In Unity 2020, it will become the only XR pipeline in Unity.
Prerequisites
To get started with the Mixed Reality Toolkit, follow the provided steps to add MRTK to a project.
Add XR SDK to a Unity project
For MRTK 2.3, Windows Mixed Reality is supported on XR SDK.
Required in Unity
- Go into Unity's Package Manager and install the Windows XR Plugin package, which adds support for Windows Mixed Reality on XR SDK. This will pull down a few dependency packages as well. Ensure the following all successfully installed:
- XR Plugin Management
- Windows XR Plugin
- XR Legacy Input Helpers
- Go to Edit > Project Settings.
- Click on the XR Plug-in Management tab in the Project Settings window.
- Go to the Universal Windows Platform settings and ensure Windows Mixed Reality is checked under Plug-in Providers.
- Ensure that Initialize XR on Startup is checked.
- (Optional) Click on the Windows Mixed Reality tab under XR Plug-in Management and create a custom settings profile to change the defaults. If the list of settings are already there, no profile needs to be created.
Required in MRTK
Choose the "DefaultXRSDKConfigurationProfile" as the active profile or clone it to make customizations. This profile is set up with MRTK's XR SDK systems and providers, where needed.
To migrate an existing profile to XR SDK, the following services and data providers should be updated:
Camera
From WindowsMixedReality.WindowsMixedRealityCameraSettings
to XRSDK.WindowsMixedReality.WindowsMixedRealityCameraSettings
and GenericXRSDKCameraSettings
Input
From WindowsMixedReality.Input.WindowsMixedRealityDeviceManager
to XRSDK.WindowsMixedReality.WindowsMixedRealityDeviceManager
Boundary
From MixedRealityBoundarySystem
Spatial awareness
From WindowsMixedReality.SpatialAwareness.WindowsMixedRealitySpatialMeshObserver
to XRSDK.WindowsMixedReality.WindowsMixedRealitySpatialMeshObserver
Controller mappings
If using custom controller mapping profiles, open one of them and run the Mixed Reality Toolkit -> Utilities -> Update -> Controller Mapping Profiles menu item to ensure the new XR SDK controller types are defined.