About the XR Plug-in Management package

Application developers use the XR Plug-in Management package to configure and manage the XR provider plug-ins in their Unity projects.

XR provider plug-in developers can use the XR Plug-in Management package to streamline XR plug-in lifecycle management and, optionally, provide users with build time UI through the Unity Unified Settings system.

Installation

You can install the XR Plug-in Management package directly from the Unity Project Settings. Refer to Configuring XR for instructions.

Use a specific production version of the package

For a released version of the package in production, referencing the package is no different than any other released package. If you can see the package in the Package Manager window, you can select and install it from there. Alternatively, you can add it manually to manifest.json like this:

    "dependencies": {
        //...
        "com.unity.xr.management":"<full version number>"
    }

Use a local copy of the package

If you want to use a local version of the package directly, you can point the Package Manager at a local folder as the location from which to get the package from.

Use the Add package from disk function on the Unity Package Manager window or edit your project's package manifest.json:

    "dependencies": {
        //...
        "com.unity.xr.management":"file:path/to/package/root"
    }

The root folder of a package is the one where the package.json file is located.

Technical details

Requirements

This version of XR Plug-in Management is compatible with the following versions of the Unity Editor:

  • 2020.3.0f1 and later

Known limitations

Attempting to manually initialize XR using XRManagerSettings.InitializeLoader from Awake could potentially interfere with graphics initialization. If you wish to manually initialize XR then call InitializeLoader from Start to ensure the graphics initialization has completed.

Package contents

This version of XR Plug-in Management includes:

  • XRManagerSettings - This is a ScriptableObject that you can use to manage XRLoader instances and their lifecycle.
  • XRLoader - This is the base class all Loaders should derive from. It provides a basic API that the XRManagerSettings can use to manage lifecycle, and a simple API you can use to request specific subsystems from the Loader.
  • XRConfigurationData - This is an attribute that allows for build and runtime settings to be hosted within the Unified Settings window. All instances display under the top-level XR entry within the Unified Settings window, using the name supplied in the script as part of the attribute. The management package uses the EditorBuildSettings config object API, stored with the key provided in the attribute, to maintain and manage the lifecycle for one instance of the build settings. You can access the configuration settings instance by retrieving the instance associated with the chosen key (as set in the attribute) from EditorBuildSettings.
  • XRPackageInitializationBase - Helper class to derive from that simplifies package initialization. Helps to create default instances of the package's XRLoader and default settings when you install the package. Initialization only runs once, and you shouldn't depend on the user to create the specified instances on their own.
  • XRBuildHelper - Abstract class useful for handling some of the boilerplate around moving settings from the Editor to the runtime. If you derive from this class and specify the appropriate settings type, the system moves settings of that type from EditorUserBuildSettings to PlayerSettings so that the system can use them at runtime.
  • XRGeneralSettings - Contains settings that apply to all XR Plug-ins, rather than any single provider.
  • Samples folder - Contains an implementation of all parts of XR Plug-in Management. You can copy this folder to your Project or package to start implementing XR Plug-in Management for your needs.