VRTK v4 beta - Virtual Reality Toolkit

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

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

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.

This repository contains an example Unity project showcasing how to use the VRTK.Prefabs package to create spatial experiences. If you only wish to use the VRTK.Prefabs within your own Unity project then follow the VRTK.Prefabs Getting Started guide.

You do not need to download anything else to get this Unity project running, simply open the downloaded Unity project in the Unity software as outlined by the Getting Started guide below.

Getting Started

Downloading the project

• Download this project repository to your local machine using one of the following methods:
  • Git clone the repository with git clone https://github.com/ExtendRealityLtd/VRTK.git
  • Download the zip file at https://github.com/ExtendRealityLtd/VRTK/archive/master.zip and extract it.

Opening the downloaded project in the Unity software

Do not drag and drop the VRTK project download into an existing Unity project. The VRTK repository download is a Unity project already and you should not nest a Unity project inside another Unity project. Follow the instructions below for opening the VRTK project within the Unity software. If you only wish to use the VRTK.Prefabs within your own Unity project then follow the VRTK.Prefabs Getting Started guide.

Using the Unity Hub

• Open the Unity Hub panel.
• Click the Add Button:

• Browse to the local directory where the repository was downloaded to and click Select Folder:

• The VRTK project will now show up in the Unity Hub project window, so select it to open the VRTK project in the Unity software:

• The VRTK project will now open within the Unity software.

Opening from within the Unity software

• Select Main Menu -> File -> Open Project within the Unity software.
• Browse to the local directory where the repository was downloaded to and click Select Folder.
• The VRTK project will now open within the Unity software.

Running the example scene

• Open the Assets/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.