Skip to content

Latest commit

 

History

History
87 lines (58 loc) · 6.21 KB

installation.md

File metadata and controls

87 lines (58 loc) · 6.21 KB
uid
xri-installation

Installation

To install this package, refer to the instructions that match your Unity Editor version. Keep in mind that each version of the Unity Editor will ship with a specific verified version of the XR Interaction Toolkit (XRI). To ensure you have access to the latest version of the XRI package, please update to the latest patch release of the Unity Editor for your project (if you are able to). If you are unable to update to the latest patch version of the Unity Editor, to access newer releases of the XR Interaction Toolkit, please refer to the Manual Installation steps below to modify your manifest.json.

Version 2022.1 and later

To install this package, follow the installation instructions in the Unity User Manual or click the following link to open Package Manager in your currently open project: com.unity.xr.interaction.toolkit. This will bring up the Add package by name box with an optional version field. Click Add to install the latest verified version of the XR Interaction Toolkit for your Unity Editor version.

Version 2021.3

2021.3.9f1 and later

To install this package (minimum version: 2.0.4), follow the installation instructions in the Unity User Manual.

2021.3.8f1 and earlier

This package was not listed in the Editor manifest in earlier versions of Unity 2021. Due to this, installation is a manual process. To install this package:

  1. Open the project that you plan to use.

  2. Click the following link to bring up the Add package by name window in Package Manager: [email protected]

    installation-add-package-by-name

  3. The version should be automatically populated, but please ensure that it is the correct version by referring to the table below.

  4. Click Add.

Text Field Value
Name com.unity.xr.interaction.toolkit
Version (optional) X.Y.Z

Note

Computer configuration issues can prevent package links from opening directly in the Unity Editor. If this happens, follow the instructions in Adding a registry package by name, using the information in the table above.

Manual Installation

In some cases, you may not be able to update the Unity Editor or may wish to manually install the latest verified or preview version of the XR Interaction Toolkit. To do this, follow these steps:

  1. Open your project folder in File Explorer, Finder or equivalent file browser.
  2. Navigate to the Packages folder and then open the manifest.json file in your favorite text editor.
  3. If you already have the XR Interaction Toolkit installed in your project, locate the line starting with com.unity.xr.interaction.toolkit and change it to X.Y.Z. If you are installing XRI for the first time, paste the following line into your manifest file inside of the dependencies block: "com.unity.xr.interaction.toolkit": "X.Y.Z", making sure to add commas to preserve a valid json structure.
  4. Save the file and close.
  5. Return to your project or open the project back up and ensure there are no errors related to the changes you just made.
  6. Open Package Manager and verify that the list now XR Interaction Toolkit with the correct version.

Input System

This package has a dependency on Input System. If that package has not already been installed, Unity will automatically add it to your Project. You might see a prompt asking you to enable input backends. Click Yes to accept it. For more information, see Enabling the new input backends in the Input System package documentation.

installation-prompt-input-backends

Interaction Layer Mask Updater

You may see a prompt asking you to upgrade your interaction layers in your project assets. If you're installing the XR Interaction Toolkit for the first time in your project, click No Thanks to skip. If you are upgrading from an older package version prior to 2.0.0, then it's recommended to update the interaction layer masks by clicking I Made a Backup, Go Ahead!. For more information, refer to Interaction Layer Mask Updater.

interaction-layer-mask-updater

Installing samples

The package comes with a number of samples, including a Starter Assets sample that contains a recommended set of input actions, controller bindings, and presets. You can install these directly from the Package Manager:

  1. Open the Package Manager window (menu: Window > Package Manager).
  2. Select the XR Interaction Toolkit from the list of packages in the project. (If you haven't added the package to the project yet, you must do so before proceeding.)
  3. Select the Samples tab.
  4. Click the Import button next to the sample you want to import.

The sample files are installed into the default location for package samples, in the Assets\Samples\XR Interaction Toolkit\[version]\ folder. You can move these assets to a different location.

For more details about individual samples, refer to the Samples page.

<script> const longVersions = document.querySelectorAll(".long_version"); for(let i = 0; i < longVersions.length; i++){ longVersions[i].innerText = thisPackageMetaData["version"]; } const kharmaLinks = document.querySelectorAll(".kharma_link"); for(let i = 0; i < kharmaLinks.length; i++){ kharmaLinks[i].innerText = thisPackageMetaData["name"] + '@' + thisPackageMetaData["version"]; kharmaLinks[i].href = 'com.unity3d.kharma:upmpackage/' + thisPackageMetaData["name"] + '@' + thisPackageMetaData["version"]; } </script>