README.md

Reality Toolkit - OpenXR

The OpenXR module for the Reality Toolkit.

Installation

Make sure to always use the same source for all toolkit modules. Avoid using different installation sources within the same project. We provide the following ways to install Reality Toolkit modules:

Method 1: OpenUPM CLI

This method requires the OpenUPM CLI to be installed on your computer.

    openupm add com.realitytoolkit.openxr

Method 2: OpenUPM Scoped Registry

If you do not wish to use the OpenUPM CLI you can also manually add the OpenUPM registry to your project and browse all available toolkit packages.

1. Open the Project Settings window.

2. Select the Package Manager settings category to the left.

3. Add a new scoped registry

   1. Name: OpenUPM
   2. URL: https://package.openupm.com
   3. Scopes: com.realitycollective and com.realitytoolkit
   4. Press Save

4. Open the Package Manager window.

5. In the top left packages filter dropdown select My Registries.

6. You'll now see all published toolkit packages listed for you to install.

Method 3: Using Package Manager for git users

1. Open the Package Manager through this menu: Window -> Package Manager.

2. Inside the Package Manager, click on the + button on the top left and select Add package from git URL....

3. Input the following URL: https://github.com/realitycollective/com.realitytoolkit.openxr.git and click Add.

Method 4: Unity Asset Store

We are working on making the Reality Toolkit available via the Unity asset store and will share news, once available.

Getting Started

Check the Getting Started documentation for the Reality Toolkit and to learn more about this module.