SteamVR Unity Plugin - Documentation at: https://valvesoftware.github.io/steamvr_unity_plugin/
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 can be found online here: https://valvesoftware.github.io/steamvr_unity_plugin/
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
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.1
Updating OpenVR sdk to 2.2.3
Added support for GetActionBindingInfo to all SteamVR_Actions
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
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 can be found online here: https://valvesoftware.github.io/steamvr_unity_plugin/
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
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
This is a RELEASE CANDIDATE. Please report any bugs immediately so we can fix them. We recommend you do not release applications with this version of the plugin.
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.
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 can be found online here: https://valvesoftware.github.io/steamvr_unity_plugin/
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
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 1.26.7
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.
Changes for 2.7.3
Changes for 2.7.2
Changes for 2.7.1
Changes for 2.7.1
Fixed issue where builds were failing #879
Fixed skeleton poser crash bug #876
Fixed WebGL builds failing #869
Unity XR: Fixed issue with other platforms not building with the package installed. #33 #71
Unity XR: Fixed issue with unity editor crashing on init for some people. #52
Updated sdk header to 1.14.15
Moved OpenVR Unity XR package to a tarball included in this project instead of NPM per Unity's new TOS.
Removing app key from binding files on build (fixes some scenarios where an indev binding file wouldn't apply to a released app)
Retargeted some DLLs to not cause issues on other platforms
Fixed an issue with some builds where the settings file wouldn't copy over properly.
Removed some resolution dialog recommendations for 2019+
Reworked the auto-enable-vr systems to be easier to manage in the future and cause less problems in the present.
Added initialPriority to SteamVR_ActivateActionSetOnLoad. Thanks for the pull request @shiena
Fixed ControllerButtonHints for URP, Thanks again for the pull request @shiena
Added RemoveAllListeners to each action type for easy delegate disposal. Thanks for the pull request @Extrys
Unity XR: Fix for laptops not always using the correct video card
Unity XR: Fixing IL2CPP issue with builds
Unity XR: Enabled user presence detection via the userPresence feature.
Unity XR: Temporary fix for Unity XR Settings reverting to defaults when users hit play in the editor and have the window open.
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.6+ Delete SteamVR folder and remove all OpenVR packages. Then install.
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 can be found online here: https://valvesoftware.github.io/steamvr_unity_plugin/
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
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.7.3
Changes for 2.7.2
Changes for 2.7.1
Changes for 2.7.1
Fixed issue where builds were failing #879
Fixed skeleton poser crash bug #876
Fixed WebGL builds failing #869
Unity XR: Fixed issue with other platforms not building with the package installed. #33 #71
Unity XR: Fixed issue with unity editor crashing on init for some people. #52
Updated sdk header to 1.14.15
Moved OpenVR Unity XR package to a tarball included in this project instead of NPM per Unity's new TOS.
Removing app key from binding files on build (fixes some scenarios where an indev binding file wouldn't apply to a released app)
Retargeted some DLLs to not cause issues on other platforms
Fixed an issue with some builds where the settings file wouldn't copy over properly.
Removed some resolution dialog recommendations for 2019+
Reworked the auto-enable-vr systems to be easier to manage in the future and cause less problems in the present.
Added initialPriority to SteamVR_ActivateActionSetOnLoad. Thanks for the pull request @shiena
Fixed ControllerButtonHints for URP, Thanks again for the pull request @shiena
Added RemoveAllListeners to each action type for easy delegate disposal. Thanks for the pull request @Extrys
Unity XR: Fix for laptops not always using the correct video card
Unity XR: Fixing IL2CPP issue with builds
Unity XR: Enabled user presence detection via the userPresence feature.
Unity XR: Temporary fix for Unity XR Settings reverting to defaults when users hit play in the editor and have the window open.
Upgrading from anything from 2.3+ Delete SteamVR folder and import. Make sure to restart the editor after everything imports successfully. Sometimes dlls get stuck in import limbo.
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 can be found online here: https://valvesoftware.github.io/steamvr_unity_plugin/
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
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/
Updated sdk header to 1.13.10
Added support for Unity XR
Added basic Universal Rendering Pipeline support
Added Exclusion for unused build targets
Fixed some error logging messages related to the old VR API.
Fixing obsolete API issue in unity 2020.2a
Moved System.ResetSeatedPosition to Chaperone.ResetZeroPosition(trackingUniverse)
Fixed some errors / warnings in 2020.1+
Fixed HDRP error that would cause SteamVR to not start. (still no hdrp support for the interaction system)
This is a RELEASE CANDIDATE. Please report any bugs immediately so we can fix them. We recommend you do not release applications with this version of the plugin.
This beta will auto-install the beta OpenVR Unity XR package on Unity 2020.1+. If you want to use Unity XR (rendering) on 2019.3/4 you can download the OpenVR-XR-Plugin-Installer in this release or from here: https://github.com/ValveSoftware/unity-xr-plugin/releases/tag/installer
Upgrading from anything from 2.6b1+ Delete SteamVR folder and remove all OpenVR packages.
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 can be found online here: https://valvesoftware.github.io/steamvr_unity_plugin/
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
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/
Fixing obsolete APIs for Unity 2020.2
Fixing auto-install of unity xr plugin for 2020.1+
Updated sdk header to 1.13.10
Moved System.ResetSeatedPosition to Chaperone.ResetZeroPosition(trackingUniverse)
Updated sdk header to 1.12.5
Added basic Universal Rendering Pipeline support
Fixed some issues with Unity XR API
Updated sdk header to 1.11.11
Added support for Unity XR API
Fixed some errors / warnings in 2020.1+
This beta release is deprecated. Please use beta 4: https://github.com/ValveSoftware/steamvr_unity_plugin/releases/tag/2.6.0b4
This beta release is deprecated. Please use beta 4: https://github.com/ValveSoftware/steamvr_unity_plugin/releases/tag/2.6.0b4
This beta release is deprecated. Please use beta 4: https://github.com/ValveSoftware/steamvr_unity_plugin/releases/tag/2.6.0b4
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 can be found online here: https://valvesoftware.github.io/steamvr_unity_plugin/
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
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/
Updated sdk header to 1.8.19
Fixes the Open Binding UI button. This should now work on all computers as it opens the window in SteamVR instead of through your default browser.
Multiple hands can now hover over one interactable.
Interactable now has a priority member. Higher numbers will make the interactable preferred when one hand is hovering over multiple interactables.
Fixed the SteamVR binding hint ui. This lets you show the user (through a SteamVR interface) what actions are mapped to what bindings in a specified set. See: SteamVR_Input.ShowBindingHints(Action), SteamVR_Input.ShowBindingHints(ActionSet), SteamVR_Input.ShowBindingHints(ActionSet), SteamVR_Input.ShowBindingHintsForActiveActionSets()
SteamVR_Behaviour_Skeleton will now initialize SteamVR if a Pose has not already done so.
Fixed default binding bug with the index hmd not responding to proximity events (controller type is "indexhmd" not "index_hmd")
Fixed bug with the SteamVR_Skeleton_Poser_Editor being offscreen
Fixed a bug with the teleport point prefabs being on the wrong layer