Skip to content

Commit 3ec34af

Browse files
keveleighkeveleigh
committed
Add Android XR docs
1 parent 1a059d1 commit 3ec34af

File tree

5 files changed

+64
-6
lines changed

5 files changed

+64
-6
lines changed

‎docs/mrtk3-overview/getting-started/setting-up/setup-new-project.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,9 @@ Once imported, MRTK3 requires a profile to be set for the standalone target plat
6767

6868
Once imported, MRTK3 requires some configuration on OpenXR if you're targeting a specific XR device. Refer to the instructions on the following pages for platform-specific guidance.
6969

70-
- [Deploy to a Quest device](../../test-and-deploy/quest-deployment.md#deployment-prerequisites)
71-
- [Deploy to HoloLens 2](../../test-and-deploy/hololens2-deployment.md#deployment-prerequisites)
70+
- [Deploy to an Android XR device](../../test-and-deploy/android-xr-deployment.md)
71+
- [Deploy to a Quest device](../../test-and-deploy/quest-deployment.md)
72+
- [Deploy to HoloLens 2](../../test-and-deploy/hololens2-deployment.md)
7273

7374
### 6. Congratulations, the project setup is now finished
7475

‎docs/mrtk3-overview/images/android-xr-openxr.png‎

134 KB
Loading

‎docs/mrtk3-overview/test-and-deploy/android-xr-deployment.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: Deploy to an Android XR device
3+
parent: Test and experience overview
4+
nav_order: 2
5+
---
6+
7+
# Deploy to an Android XR device
8+
9+
This page describes how to deploy your Unity Project with MRTK3 onto an Android XR device.
10+
11+
> [!NOTE]
12+
> For general Android XR and Unity information, see the [Android XR developer docs](https://developer.android.com/develop/xr/unity).
13+
14+
## Deployment Prerequisites
15+
16+
1. Add MRTK to your project and ensure your [project settings](../getting-started/setting-up/setup-new-project.md#5-configure-openxr-related-settings) are configured correctly to use the OpenXR pipeline and MRTK's feature set. **These features are required to deploy your project onto your Android XR device**.
17+
18+
> [!NOTE]
19+
> If starting from the [template project](../getting-started/setting-up/setup-template.md), these project settings should already be configured for you.
20+
21+
1. Navigate to **File > Build Settings**.
22+
23+
1. Under **Platform**, select **Android**. Switch the platform to **Android**, and wait for the operation to finish.
24+
25+
1. Navigate to **Edit > Project Settings**.
26+
27+
1. Under **Project Settings**, navigate to **XR Plug-in Management** and enable **OpenXR** under the **Android** tab. Ensure that **Initialize XR on Startup** is selected and that no feature groups are enabled, and wait for the operation to finish.
28+
29+
![Android XR Plug-in Management window](../images/android-xr-plug-in-management.png)
30+
31+
> [!NOTE]
32+
> A yellow warning icon may appear after checking the **OpenXR** option. Click that icon to open the **OpenXR Project Validation** tool. Click **Fix all** and ignore the interaction profile issue that can't be auto-fixed. The profiles will be added in the step below.
33+
34+
1. Under **Project Settings**, navigate to **XR Plug-in Management > OpenXR > Interaction Profiles** and ensure the following profiles are listed based on the MRTK features you'd like to use:
35+
36+
| Profile | MRTK |
37+
|---------|------|
38+
| Hand Interaction Profile | For articulated hand input |
39+
| Oculus Touch Controller Profile | For controller input |
40+
41+
1. Under **Project Settings**, navigate to **XR Plug-in Management > OpenXR > OpenXR Feature Groups** and ensure the following features are checked under **All Features** based on the MRTK features you'd like to use:
42+
43+
| Feature | MRTK |
44+
|---------|------|
45+
| Android XR: AR Session <br> Android XR: Hand Mesh Data | For rendering the system hand mesh |
46+
| Hand Tracking Subsystem | For rendering the articulated hand joints |
47+
48+
![Android XR OpenXR](../images/android-xr-openxr.png)
49+
50+
> [!NOTE]
51+
> You can enable additional features as needed, but in-scene support for them will come from other packages, like AR Foundation.
52+
53+
1. A yellow warning icon or red error icon may appear during this process. Click that icon to open the **OpenXR Project Validation** tool. Select **Fix All** to address the issues. There may be several items to address.
54+
55+
## Deploying to Device
56+
57+
1. After you have the project configured, proceed to [build and run the Unity Project](https://docs.unity3d.com/Manual/xr-run.html).

‎docs/mrtk3-overview/test-and-deploy/hololens2-deployment.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This page describes how to deploy your Unity Project with MRTK3 onto a HoloLens
1616
1. Add MRTK to your project and ensure your [project settings](../getting-started/setting-up/setup-new-project.md#5-configure-openxr-related-settings) are configured correctly to use the OpenXR pipeline and MRTK's feature set. **These features are required to deploy your project onto your HoloLens**.
1717

1818
> [!NOTE]
19-
> If starting from our [template project](../getting-started/setting-up/setup-template.md), these project settings should already be configured for you.
19+
> If starting from the [template project](../getting-started/setting-up/setup-template.md), these project settings should already be configured for you.
2020
2121
1. Navigate to **File > Build Settings**.
2222

‎docs/mrtk3-overview/test-and-deploy/quest-deployment.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ These steps are based around OpenXR as your runtime (i.e. XR plugin provider) as
1919

2020
1. Ensure that [developer mode](https://developer.oculus.com/documentation/native/android/mobile-device-setup/#enable-developer-mode) is enabled on your device (you may need to [join a developer team](https://developers.meta.com/horizon/documentation/native/android/mobile-device-setup/#joining-or-creating-a-team) first). Installing the Oculus ADB Drivers is optional.
2121

22-
1. Add MRTK to your project and ensure that your [project settings](../getting-started/setting-up/setup-new-project.md#5-configure-openxr-related-settings) are configured correctly to use the OpenXR pipeline and MRTK's feature set. **These features are required to deploy your project onto your Quest device**. You may ignore project settings instructions regarding the UWP platform.
22+
1. Add MRTK to your project and ensure that your [project settings](../getting-started/setting-up/setup-new-project.md#5-configure-openxr-related-settings) are configured correctly to use the OpenXR pipeline and MRTK's feature set. **These features are required to deploy your project onto your Quest device**.
2323

2424
> [!NOTE]
25-
> If starting from our [template project](../getting-started/setting-up/setup-template.md), these project settings should already be configured for you.
25+
> If starting from the [template project](../getting-started/setting-up/setup-template.md), these project settings should already be configured for you.
2626
2727
1. Navigate to **File > Build Settings**.
2828

@@ -41,8 +41,8 @@ These steps are based around OpenXR as your runtime (i.e. XR plugin provider) as
4141

4242
| Profile | MRTK |
4343
|---------|------|
44-
| Oculus Touch Controller Profile | For controller input |
4544
| Hand Interaction Profile | For articulated hand input |
45+
| Oculus Touch Controller Profile | For controller input |
4646

4747
1. Under **Project Settings**, navigate to **XR Plug-in Management > OpenXR > OpenXR Feature Groups** and ensure the following features are checked under **All Features** based on the MRTK features you'd like to use:
4848

0 commit comments

Comments
 (0)