UnitySubsystemsManifest.json

Note: The Unity XRAn umbrella term encompassing Virtual Reality (VR), Augmented Reality (AR) and Mixed Reality (MR) applications. Devices supporting these forms of interactive applications can be referred to as XR devices. More info
See in Glossary SDK is no longer available as we have focused our investments towards OpenXR.

UnitySubsystemsManifest.json contains metadata about your provider that can be queried before your plug-inA set of code created outside of Unity that creates functionality in Unity. There are two kinds of plug-ins you can use in Unity: Managed plug-ins (managed .NET assemblies created with tools like Visual Studio) and Native plug-ins (platform-specific native code libraries). More info
See in Glossary is loaded. The values in this dictionary are used to populate specific instances of SubsystemDescriptors in C#. For example, information within the displays list is used to populate XRDisplaySubsystemDescriptors.

For Unity to find the a native library referenced by the UnitySubsystemsManifest.json file, the library must be no more than two subfolders deeper than the UnitySubsystemsManifest.json file.

Example .json file:

{
    "name": "PluginName",
    "version": "1.0.0",
    "libraryName": "UnityXRDisplayExample",

    "displays": [
        {
            "id": "Display0",
            "supportedMirrorBlitReservedModes" : ["leftEye","rightEye", "sideBySide"]
        }
    ],
    "inputs:": [
        {
            "id": "MockHMD Head Tracking Stationary"
        },
        {
            "id": "MockHMD Head Tracking Simulated"
        }
    ]
}

Metadata	Description
`name`	The name of your provider. Must match the first parameter of your native plug-inA platform-specific native code library that is created outside of Unity for use in Unity. Allows you can access features like OS calls and third-party code libraries that would otherwise not be available to Unity. More info See in Glossary’s `RegisterLifecycleHandler` call. Likely to show up in UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info See in Glossary in the future.
`version`	Unused currently. Likely to show up in UI in the future.
`libraryName`	Must match the name of your provider’s native plug-in binary without the extension.
`displays`	Collection of Display subsystem providers.
`id`	Identifier for this display plug-in configuration. The `id` must match the string you pass into your native plug-in’s `RegisterLifecycleHandler` call for that subsystem. You can have more than one `display`, as long as your native plugin calls `RegisterLifecycleHandler` for each.
`inputs`	Collection of Input subsystem providers.

Your manifest file can include other displays after id - subsystems specify which parameters are valid.

Creating an XR provider

Runtime discovery and activation of subsystems

Unity Manual

UnitySubsystemsManifest.json