Skip to content

Commit 932506d

Browse files
authored
Merge pull request #184750 from stefanhessel/tutorial-switch-to-open-xr
Update Unity tutorial instructions to use OpenXR
2 parents e29a1f1 + aa8afef commit 932506d

18 files changed

+113
-63
lines changed

articles/remote-rendering/how-tos/unity/install-remote-rendering-unity-package.md

Lines changed: 42 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,36 +10,47 @@ ms.topic: how-to
1010
# Install the Remote Rendering package for Unity
1111

1212
Azure Remote Rendering uses a Unity package to encapsulate the integration into Unity.
13-
This package contains the entire C# API as well as all plugin binaries required to use Azure Remote Rendering with Unity.
13+
This package contains the entire C# API and all plugin binaries required to use Azure Remote Rendering with Unity.
1414
Following Unity's naming scheme for packages, the package is called **com.microsoft.azure.remote-rendering**.
1515

16+
The package is not part of the [ARR samples repository](https://github.com/Azure/azure-remote-rendering), and it is not available from Unity's internal package registry.
1617
You can choose one of the following options to install the Unity package.
1718

1819
## Install Remote Rendering package using the Mixed Reality Feature Tool
1920

20-
[The Mixed Reality Feature Tool](/windows/mixed-reality/develop/unity/welcome-to-mr-feature-tool) ([download](https://aka.ms/mrfeaturetool)) is a tool used to integrate Mixed Reality feature packages into Unity projects. The package is not part of the [ARR samples repository](https://github.com/Azure/azure-remote-rendering), and it is not available from Unity's internal package registry.
21+
The [Mixed Reality Feature Tool](/windows/mixed-reality/develop/unity/welcome-to-mr-feature-tool) ([download](https://aka.ms/mrfeaturetool)) integrates Mixed Reality feature packages into Unity projects.
22+
23+
To add the package to a project, you need to:
2124

22-
To add the package to a project you need to:
2325
1. [Download the Mixed Reality Feature Tool](https://aka.ms/mrfeaturetool)
2426
1. Follow the [full instructions](/windows/mixed-reality/develop/unity/welcome-to-mr-feature-tool) on how to use the tool.
25-
1. On the **Discover Features** page tick the box for the **Microsoft Azure Remote Rendering** package and select the version of the package you wish to add to your project
27+
1. On the **Discover Features** page, tick the box for the **Microsoft Azure Remote Rendering** package under **Azure Mixed Reality Services** and select the version of the package you wish to add to your project
28+
1. If you want to use OpenXR, also add the **Mixed Reality OpenXR Plugin** package under **Azure Mixed Reality Services** in the same way.
2629

2730
![Mixed_Reality_feature_tool_package](media/mixed-reality-feature-tool-package.png)
2831

29-
To update your local package just select a newer version from the Mixed Reality Feature Tool and install it. Updating the package may occasionally lead to console errors. If this occurs, try closing and reopening the project.
32+
To update your local package, just select a newer version from the Mixed Reality Feature Tool and install it. Updating the package may occasionally lead to console errors. If you see errors in the console, try closing and reopening the project.
3033

3134
## Install Remote Rendering package manually
3235

3336
To install the Remote Rendering package manually, you need to:
3437

3538
1. Download the package from the Mixed Reality Packages NPM feed at `https://pkgs.dev.azure.com/aipmr/MixedReality-Unity-Packages/_packaging/Unity-packages/npm/registry`.
3639
* You can either use [NPM](https://www.npmjs.com/get-npm) and run the following command to download the package to the current folder.
37-
```
40+
41+
```cmd
3842
npm pack com.microsoft.azure.remote-rendering --registry https://pkgs.dev.azure.com/aipmr/MixedReality-Unity-Packages/_packaging/Unity-packages/npm/registry
3943
```
4044
45+
If you want to use OpenXR, run the following command to download the platform support package to the current folder.
46+
47+
```cmd
48+
npm pack com.microsoft.mixedreality.openxr --registry https://pkgs.dev.azure.com/aipmr/MixedReality-Unity-Packages/_packaging/Unity-packages/npm/registry
49+
```
50+
4151
* Or you can use the PowerShell script at `Scripts/DownloadUnityPackages.ps1` from the [azure-remote-rendering GitHub repository](https://github.com/Azure/azure-remote-rendering).
4252
* Edit the contents of `Scripts/unity_sample_dependencies.json` to
53+
4354
```json
4455
{
4556
"packages": [
@@ -52,22 +63,42 @@ To install the Remote Rendering package manually, you need to:
5263
}
5364
```
5465
55-
* Run the following command in PowerShell to download the package to the provided destination directory.
66+
If you want to use OpenXR, you also need the platform support package. Edit the contents of `Scripts/unity_sample_dependencies.json` to
67+
68+
```json
69+
{
70+
"packages": [
71+
{
72+
"name": "com.microsoft.azure.remote-rendering",
73+
"version": "latest",
74+
"registry": "https://pkgs.dev.azure.com/aipmr/MixedReality-Unity-Packages/_packaging/Unity-packages/npm/registry"
75+
},
76+
{
77+
"name": "com.microsoft.mixedreality.openxr",
78+
"version": "latest",
79+
"registry": "https://pkgs.dev.azure.com/aipmr/MixedReality-Unity-Packages/_packaging/Unity-packages/npm/registry"
80+
}
81+
]
82+
}
5683
```
84+
85+
* Run the following command in PowerShell to download the package to the provided destination directory.
86+
87+
```PowerShell
5788
DownloadUnityPackages.ps1 -DownloadDestDir <destination directory>
5889
```
5990
60-
1. [Install the downloaded package](https://docs.unity3d.com/Manual/upm-ui-tarball.html) with Unity's Package Manager.
91+
1. [Install the downloaded package(s)](https://docs.unity3d.com/Manual/upm-ui-tarball.html) with Unity's Package Manager.
6192
62-
To update your local package just rerun the respective command you used and reimport the package. Updating the package may occasionally lead to console errors. If this occurs, try closing and reopening the project.
93+
To update a local package, just repeat the respective download steps you used and reimport the package. Updating the package may occasionally lead to console errors. If you see errors in the console, try closing and reopening the project.
6394
6495
## Unity render pipelines
6596
6697
Remote Rendering works with both the **:::no-loc text="Universal render pipeline":::** and the **:::no-loc text="Standard render pipeline":::**. For performance reasons, the Universal render pipeline is recommended.
6798
68-
To use the **:::no-loc text="Universal render pipeline":::**, its package has to be installed in Unity. This can either be done in Unity's **Package Manager** UI (package name **Universal RP**, version 7.3.1 or newer), or through the `Packages/manifest.json` file, as described in the [Unity project setup tutorial](../../tutorials/unity/view-remote-models/view-remote-models.md#include-the-azure-remote-rendering-package).
99+
To use the **:::no-loc text="Universal render pipeline":::**, its package has to be installed in Unity. The installation can either be done in Unity's **Package Manager** UI (package name **Universal RP**, version 7.3.1 or newer), or through the `Packages/manifest.json` file, as described in the [Unity project setup tutorial](../../tutorials/unity/view-remote-models/view-remote-models.md#include-the-azure-remote-rendering-and-openxr-packages).
69100
70101
## Next steps
71102
72103
* [Unity game objects and components](objects-components.md)
73-
* [Tutorial: View Remote Models](../../tutorials/unity/view-remote-models/view-remote-models.md)
104+
* [Tutorial: View Remote Models](../../tutorials/unity/view-remote-models/view-remote-models.md)
24 KB
Loading
-1.21 KB
Loading
6 Bytes
Loading
-89 Bytes
Loading
302 Bytes
Loading
-5 Bytes
Loading
-587 Bytes
Loading
2.91 KB
Loading
87.5 KB
Loading

0 commit comments

Comments
 (0)