You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/remote-rendering/how-tos/unity/install-remote-rendering-unity-package.md
+42-11Lines changed: 42 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,36 +10,47 @@ ms.topic: how-to
10
10
# Install the Remote Rendering package for Unity
11
11
12
12
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.
14
14
Following Unity's naming scheme for packages, the package is called **com.microsoft.azure.remote-rendering**.
15
15
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.
16
17
You can choose one of the following options to install the Unity package.
17
18
18
19
## Install Remote Rendering package using the Mixed Reality Feature Tool
19
20
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:
21
24
22
-
To add the package to a project you need to:
23
25
1.[Download the Mixed Reality Feature Tool](https://aka.ms/mrfeaturetool)
24
26
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.
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.
30
33
31
34
## Install Remote Rendering package manually
32
35
33
36
To install the Remote Rendering package manually, you need to:
34
37
35
38
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`.
36
39
* You can either use [NPM](https://www.npmjs.com/get-npm) and run the following command to download the package to the current folder.
* 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).
42
52
* Edit the contents of `Scripts/unity_sample_dependencies.json` to
53
+
43
54
```json
44
55
{
45
56
"packages": [
@@ -52,22 +63,42 @@ To install the Remote Rendering package manually, you need to:
52
63
}
53
64
```
54
65
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
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.
61
92
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.
63
94
64
95
## Unity render pipelines
65
96
66
97
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.
67
98
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).
69
100
70
101
## Next steps
71
102
72
103
* [Unity game objects and components](objects-components.md)
0 commit comments