Guides
These docs are for v3.0.0. Click to read the latest docs for v3.3.0.

Getting Started

VRTK requires a supported VR SDK to be imported into your Unity3d Project.

  • Clone this repository git clone https://github.com/thestonefox/VRTK.git.
  • Open VRTK within Unity3d.
  • Add the VRTK_SDKManager script to a GameObject in the scene.

Instructions for using the VR Simulator

  • Drag the VRSimulatorCameraRig prefab from the VRTK/Prefabs into the
    scene.
  • Select the GameObject with the VRTK_SDKManager script attached
    to it.
  • Select Simulator for each of the SDK Choices.
  • Click the Auto Populate Linked Objects button to find the
    relevant Linked Objects.
  • Use the Left Alt to switch between mouse look and move a hand.
  • Press Tab to switch between left/right hands.
  • Hold Left Shift to change from translation to rotation for the hands.
  • Hold Left Crtl to switch between X/Y and X/Z axis.
  • All above keys can be remapped using the inspector on the VRSimulatorCameraRig prefab.
  • Button mapping for the VR control are as follows:
  • Grip: Left mouse button
  • Trigger: Right mouse button
  • Touchpad Press: Q
  • Button One: E
  • Button Two: R

Instructions for using the SteamVR Unity3d asset

  • Import the SteamVR Plugin from the Unity Asset Store.
  • Drag the [CameraRig] prefab from the SteamVR plugin into the scene.
  • Check that Virtual Reality Supported is ticked in the Edit -> Project Settings -> Player menu.
  • Ensure that OpenVR is added in the Virtual Reality SDKs list in the Edit -> Project Settings -> Player menu.
  • Select the GameObject with the VRTK_SDKManager script attached to it.
  • Select Steam VR for each of the SDK Choices.
  • Click the Auto Populate Linked Objects button to find the relevant Linked Objects.
  • Optionally, browse the Examples scenes for example usage of the scripts.

Instructions for using the Oculus Utilities Unity3d package

  • Download the Oculus Utilities from the Oculus developer website.
  • Import the OculusUtilities.unitypackage into the project.
  • Drag the OVRCameraRig prefab from the Oculus package into the scene.
  • Check that Virtual Reality Supported is ticked in the Edit -> Project Settings -> Player menu.
  • Ensure that Oculus is added in the Virtual Reality SDKs list in the Edit -> Project Settings -> Player menu.
  • Select the GameObject with the VRTK_SDKManager script attached to it.
  • Select Oculus VR for each of the SDK Choices.
  • Click the Auto Populate Linked Objects button to find the relevant Linked Objects.