VRTK v4 beta - Virtual Reality Toolkit

A productive toolkit for rapidly building spatial computing solutions in the Unity software.

Beta Disclaimer

VRTK v4 has not yet been released fully is still in the beta phase meaning there may still be undiscovered bugs, missing features and a lack of usable documentation. All of these things are being worked on but progress is slow as there is only one person actively working on VRTK v4 in their spare time so please be patient and respectful. You are free to use VRTK v4 in any way you wish, but if you feel you will struggle figuring stuff out for yourself without detailed documentation then it may be better off if you wait until the full release of VRTK v4.

Introduction

VRTK aims to make building spatial computing solutions in the Unity software fast and easy for beginners as well as experienced developers.

Requires the Unity software version 2018.3.10f1 (or above).

Getting Started

Documentation

Visit the VRTK.Academy for a collection of educational content to help you get the most out of building spatial computing solutions with VRTK.

Setting up the project

• Create a new project in the Unity software version 2018.3.10f1 (or above) using 3D Template or open an existing project.
• Ensure Virtual Reality Supported is checked:
  • In the Unity software select Main Menu -> Edit -> Project Settings to open the Project Settings window.
  • Select Player from the left hand menu in the Project Settings window.
  • In the Player settings panel expand XR Settings.
  • In XR Settings ensure the Virtual Reality Supported option is checked.
• Ensure the project Scripting Runtime Version is set to .NET 4.x Equivalent:
  • In the Unity software select Main Menu -> Edit -> Project Settings to open the Project Settings inspector.
  • Select Player from the left hand menu in the Project Settings window.
  • In the Player settings panel expand Other Settings.
  • Ensure the Scripting Runtime Version is set to .NET 4.x Equivalent.

Note: Unity 2019.1 requires additional project setup before importing VRTK.

• Download and install the XR Legacy Input Helpers from the Unity Package Manager.
  • In the Unity software select Main Menu -> Window -> Package Manager to open the Package Manager window.
  • Select XR Legacy Input Helpers from the Packages tab in the Package Manager window.
  • Click the Install button located in the bottom right of the Package Manager window.
  • The XR Legacy Input Helpers package will now download and install into the project.

Adding VRTK to a project

• Navigate to the Packages directory of your project.

• Adjust the [project manifest file][Project-Manifest] manifest.json in a text editor.

  • Ensure https://npm.pkg.github.com/ExtendRealityLtd is part of scopedRegistries.
    • Ensure @extendrealityltd is part of scopes.
  • Add @extendrealityltd/vrtk to dependencies, stating the latest version.

  A minimal example ends up looking like this. Please note that the version X.Y.Z stated here is to be replaced with the latest released version.

  {
    "scopedRegistries": [
      {
        "name": "ExtendRealityLtd",
        "url": "https://npm.pkg.github.com/ExtendRealityLtd",
        "scopes": [
          "@extendrealityltd"
        ]
      }
    ],
    "dependencies": {
      "@extendrealityltd/vrtk": "X.Y.Z",
      ...
    }
  }

• Switch back to the Unity software and wait for it to finish importing the added package.

Running the example scene

• Within the Unity software's Project window expand the Packages node.
• Expand the child node of the VRTK package.
• Open the Samples/Farm/Scenes/ExampleScene scene.
• Enable Maximize On Play in the Unity Game view control bar to ensure no performance issues are caused by the Unity Editor overhead.
• Play the scene in the Unity Editor (CTRL + P).
• The scene should automatically play within any Unity supported XR hardware.
• Explore the farm yard and enjoy!

Made With VRTK

Many games and experiences have already been made with VRTK.

Check out the Made With VRTK website to see the full list.

Contributing

We're not currently in a place where accepting contributions would be helpful. But as soon as we're ready we'll let you know!

License

Code released under the MIT License.

Disclaimer

These materials are not sponsored by or affiliated with Unity Technologies or its affiliates. "Unity" is a trademark or registered trademark of Unity Technologies or its affiliates in the U.S. and elsewhere.