Upgrading from older versions
Upgrading from anything from 2.6+
Delete SteamVR folder and remove all OpenVR packages in package manager. Then install. If there are errors reported after installation you may need to reimport the project.
This release will auto-install the OpenVR Unity XR package on Unity 2020.1+ from the included tarball. This is a different installation method than was previously used (npm). If you want to use Unity XR (rendering) on 2019.3/4 you a dialog will pop up giving you that option.
Upgrading from anything from 2.3+
Delete SteamVR folder and import
Upgrading from anything from 2.1 - 2.3
The location of actions.json and associated bindings has changed. They will get automatically moved from project root to StreamingAssets/SteamVR/
Upgrading from version 2.0
You will need to delete your SteamVR/SteamVR_Input folders, Save and Generate, and then re-set your actions that you've assigned in the editor. You do not need to recreate your actions file or bindings files. This was necessary to support Unity's new serialization in 2018/2019. If you've made changes to your SteamVR/Resources/SteamVR_Settings.asset file, remember to keep it.
Upgrading your project from 1.2.3 or below
You will need to delete the SteamVR folder and rewrite your input layer. See the new documentation site here: https://valvesoftware.github.io/steamvr_unity_plugin/ for more information. If you don't want to do that then do not upgrade to this version.
Documentation
Documentation can be found online here: https://valvesoftware.github.io/steamvr_unity_plugin/
Quick Start
If you want to explore the interaction scene you'll need to open the SteamVR Input window (under the Window Menu), click yes to copy example jsons, then click Save and Generate to create input actions.
For the most simple example of VR with tracked controllers see the sample scene at SteamVR/Simple Sample
For a more extensive example including picking up, throwing objects, and animated hands see the Interaction System example at SteamVR/Interaction System/Samples/Interactions_Example
Support
If you're having trouble with the plugin the best place to discuss issues is our github here: https://github.com/ValveSoftware/steamvr_unity_plugin/issues/
If you'd like to discuss features, post guides, and give general feedback please post on the steam forum here: https://steamcommunity.com/app/250820/discussions/7/
Changes for 2.8.0
-
Updating OpenVR sdk to 2.0.10
-
Added knee, elbow, ankle, and wrist input sources.
-
Updated urls to sidestep log spam in Unity 2022
-
Fixed compiler errors in some plugin update scenarios.
-
Fixed the interaction system not being able to create interactables at runtime
-
Fixed reimports erasing openvr settings on some machines
-
Fixed the interaction system not respecting the hand clearance mask
-
Fixed the interaction system teleport example not working while using the 2d fallback
-
Fixed RemoveAllListeners not removing all listeners
-
Various performance and garbage collection fixes
-
Fix for multipass breaking under scriptable render pipelines.
-
Fix for unnecessary preinit that was breaking some startup scenarios
-
Fix for incorrect reporting of eye position
-
Fix for broken depth textures in some situations
-
Fixed some scenarios where OpenGL wouldn't work.
-
Fix for projects that use binary serialization. (Settings file gets output on build now)
-
Better support for unicode app names and keys
-
Fix for some projects in linux not loading manifests properly.
-
Fixed a localization issue preventing some projects with unicode characters in the path from working.
-
Fixed the interaction system not handling the bow and arrow correctly under newer physics simulations
-
Fixed the interaction system not dismissing grip hints correctly