Skip to content

Home

Jump to bottom
Rune Berg edited this page Dec 13, 2019 · 18 revisions

Valve maintains an Unreal plugin to smoothly interface SteamVR Input with Unreal. This Input specific plugin is built to run along side the existing SteamVR plugin that continues to handle rendering. The goal of the plugin is to integrate SteamVR Input features in an intuitive and easy to use way for existing and future Unreal developers. With SteamVR Input, developers can target one API that all the popular VR headsets can connect to and can support many different controllers with little to no code changes.

The modern SteamVR Input Unreal Plugin manages three main things for developers:

  1. Unreal Input Action to SteamVR Input Action mapping
  2. Per controller type key bindings
  3. Estimating what your hand looks like while using VR controllers

To show an example of these, there are two sample maps. One showing sample interactions with a SteamVR hand skeleton and one showing sample interactions with the skeleton from the Unreal VR Template. These interactions use different key mappings per controller that the developer - and end user - can rebind at runtime.

We recommend developers opt-in to SteamVR Beta.

Sample Project

You can find a sample project for download here:

UE 4.15 - 4.23: https://github.com/ValveSoftware/steamvr_unreal_plugin/wiki/sample/SteamVRInputPlugin.zip

UE 4.24 and above: https://github.com/ValveSoftware/steamvr_unreal_plugin/wiki/sample/SteamVRInputPlugin_UEIntegrated.7z

Requirements

The SteamVR runtime must be installed. This can be downloaded from Steam under the Tools category. Or by clicking here. As developers, we strongly recommend that you opt-in to SteamVR beta so you can test new features and verify your application works with the latest versions of SteamVR.

Quick Start

  • Follow the Quickstart Guide

  • Install the plugin and an action manifest and bindings should auto generate for you. These get placed into Config/SteamVRBindings.

  • Input Actions and Axis get auto mapped to SteamVR so you can use them as you normally would.

  • Sample maps can be found in SteamVR Input Content/Sample/Maps. Click the eye in the lower right hand corner of your Content Browser and click Show Plugin Content to get access to that folder. Click the SteamVR Input toolbar menu and "Add Sample Inputs" to add inputs and mappings to your project.

  • The VR Template included with Unreal Engine should work by default.

Support

If you're having trouble with the plugin the best place to discuss issues is our github here: https://github.com/ValveSoftware/steamvr_unreal_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/

Clone this wiki locally