SteamVR Unity Plugin

Documentation

Full documentation is available online at: https://valvesoftware.github.io/steamvr_unity_plugin/

Support

• Technical Issues: Discuss bugs and issues on the GitHub Issues page.
• Feedback and Features: Post guides, general feedback, and feature requests on the Steam Community Discussion forum.

To upgrade to a new version of the plugin safely, follow these steps:

1. Delete your existing SteamVR folder.
2. Delete any files or folders in your Plugins directory named openvr_api, steam_api, or steam_unity (including variants).
3. Verify that no SteamVR files exist in Assets/Editor.
4. Import the new .unitypackage into your project.

The plugin includes several sample scenes to demonstrate different levels of complexity:

• Simple VR with Tracked Controllers: For a minimal implementation, open the scene located at /SteamVR/Simple Sample.
• Interaction System Example: For a comprehensive implementation including object picking, throwing, and animated hands, open the scene at /SteamVR/Interaction System/Samples/Interactions_Example.

If you are exploring the Interaction System example, you must generate the necessary input actions manually:

1. Open the SteamVR Input window via the Unity Window menu.
2. When prompted, click Yes to copy the example JSON files.
3. Click Save and Generate to create the required input actions.

To use the SteamVR Unity Plugin, ensure the following requirements are met:

1. SteamVR Runtime: Must be installed on the system. It can be found in the Steam 'Tools' category or via the Steam Store.
2. SteamVR Beta: It is strongly recommended to opt-in to the SteamVR beta to test new features and ensure compatibility with the latest SteamVR versions.
3. Unity Version: This version of the plugin is compatible and tested with Unity versions 5.4 through 2019.1.

If you publish your game on Steam, you can allow users to change input bindings outside of the game by designating your title as a SteamVR Input application.

Steps to configure on Steamworks:

1. Go to the Steamworks Partner Site.
2. Navigate to Application settings -> Virtual Reality Section.
3. Select the radio button to designate your title as a SteamVR Input application.
4. Set the location of your action manifest.

Manifest Location:

• For plugin versions 2.3.3 and above, the manifest must be located at: [GameName]_Data/StreamingAssets/SteamVR/actions.json

To use the SteamVR Input system and explore interaction scenes, you must generate the necessary input action files:

1. Open the SteamVR Input window (found under the Window menu in Unity).
2. If prompted, click yes to copy the example JSON files.
3. Click Save and Generate to create the required input actions.

For learning purposes, you can explore these sample scenes included in the plugin:

• Simple VR Example: SteamVR/Simple Sample (Basic tracked controller interaction).
• Interaction System Example: SteamVR/Interaction System/Samples/Interactions_Example (Advanced features like picking up, throwing objects, and animated hands).

Common errors and their solutions:

The SteamVR_Overlay.cs component is used to render 2D content (like UI) on a virtual curved surface in VR.

Usage

• Drag the component into the Hierarchy window (rather than the Scene window) to ensure it retains its default position at the origin.
• To use it for specific scenes, add the component to those scenes and set its Texture property to None in scenes where you do not want it rendered.

SteamVR broadcasts several events that can be handled by registering via SteamVR_Events.<EventType>.Listen.

Best Practice: Always call Remove in OnDisable to avoid memory leaks or errors when components are destroyed.

Available Events

• Initializing: Sent when the HMD's tracking status changes to or from Uninitialized.
• Calibrating: Sent when starting or stopping calibration.
• OutOfRange: Sent when losing or reacquiring absolute positional tracking.
• DeviceConnected: Sent when devices are connected or disconnected. Arguments: int deviceIndex, bool connectedStatus.

void OnEnable() {
    SteamVR_Events.DeviceConnected.Listen(OnDeviceConnected);
}

void OnDisable() {
    SteamVR_Events.DeviceConnected.Remove(OnDeviceConnected);
}

void OnDeviceConnected(int index, bool connected) {
    // Handle connection
}

The SteamVR_RenderModel.cs component dynamically creates SteamVR-provided models for tracked objects.

Models can be overridden by placing files in <SteamVR Runtime Path>/resources/rendermodels.