May 31, 2022
Note: This tutorial includes visuals of the old UI. Updates follows soon.
In this VR Builder tutorial, you will learn how to set up VR Builder. After following this tutorial, you will have your Unity project ready to run in VR as well as the foundation to explore more VR Builders capabilities in Unity. If you are familiar with Unity already, you likely want to skip some of the first chapters. In the next chapters, we will cover:
For this VR Builder tutorial we assume you have already installed Unity and created a new, empty project. If you haven't installed Unity yet, you can find excellent documentation on how to do this right from Unity themselves:
If you are completely new to Unity, you might also want to check some basic concepts. The documentation on how to use the Unity Editor and Unity Learn are both valuable resources to do so. If you are not sure which Unity version to use, we'd recommend using one of the newest LTS (long term support) versions.
In case of doubt, please also check the compatibility section of the VR Builder description on the Unity Asset Store.
Please have Unity running and a new, empty project open before continuing. This ensures that VR Builder will be added to the right project.
The easiest way to get VR Builder from the Unity Asset Store is to visit VR Builder's product page.
The next 3 steps are:
In your web browser, on the right side of the Asset Store product page, you can find the button Add to My Assets. Select this button.
After that, the same button will change to Open in Unity. Press select this button again to get back to your Unity project.
This opens the Package Manager. Select VR Builder from your assets. Then press download and after the download is completed import.
A pop up will appear showing you all the files to be added to the Unity project. Just confirm the selection by pressing Import.
Congratulations! You now have imported the first part of VR Builder, including the Core Package Manager, the demo scene, as well as some offline documentation. For technical reasons, another part still needs to be added. For your convenience, this is a mostly automated process. We will now guide you through how to do it.
After import VR Builder from the Unity Asset Store, the Core Package Manager pops up:
Click on Add registry. This adds a new entry to the Unity package registry and allows VR Builder to load the open source core package from openupm.com. Then, confirm adding the registry by pressing Ok.
With the registry added, the VR Builder core package can now automatically be downloaded and installed. Choose Install version … (latest), which in our case is version 1.1.0.
Another pop-up informs you about the successful import of the registry. You can close this pop up.
You can see that the registry was added in Project Settings -> Package Manager.
Wait until the import is finished and the next pop up appears. Confirm restart to enable the new Unity input system.
Wait again until the import is finished. The Setup Wizard pops up.
The Setup Wizard helps to get new or existing Unity scenes set up and ready to be used with VR Builder. In the following we will guide you through the different tabs of the VR Builder Setup Wizard.
Welcome to the VR Builder Setup Wizard. Press Next on the bottom right.
In the next step, you can choose the interaction component. A default interaction component based on Unity's XR Interaction Toolkit is provided, and will be prompted for installation. Unless you plan to use some custom or third-party interaction component, such as the one provided by our partner Interhaptics, just select the default interaction component and click "Restart". Following, the required packages will be installed, and afterwards the wizard will restart.
After restarting, you can proceed with the wizard and select Take my current scene.
In the field Name of your VR Process you can enter a fitting name for your VR process. It is also possible to change it later. Enter a name and then press Next.
Alternatively, if you want to explore some of VR Builder's capabilities in VR, check out the Demo Scene of the VR Builder Core Package. In the Unity Packages window, you can find our Quickstart Guide in VR Builder -> Documentation. There, you can explore the VR Builder Demo scene - a showcase of the fundamental concepts of our standard VR interactions and how to guide people in VR. It allows you to to peek behind the curtain by looking at the process in the Workflow Editor. Play around by adding more steps, behaviors, and conditions or by changing the process flow and see how this changes the VR experience.
Select the device category you want to support and press Next. If your hardware is not listed, please reach out to us in the VR Builder Community, where you will receive direct help from us.
Here you can find helpful links for your VR development in Unity. Make sure to check them out once in a while. For now, complete setting up your Unity project by pressing Finish.
Press Continue to enable XR Plugin Management. Depending on the hardware you selected, a second pop up might appear which you need to confirm again by pressing Continue.
Everything is ready! You can now close the Core Package Manager window.
In this VR Builder tutorial you learned how to set up VR Builder for a Unity project. Now that your Unity Project is up and running for VR, we recommend checking out the tutorial on VR Builder's Workflow editor.