Installation and setup
To use VERA, you need to install Unity, as well as the VERA Unity package. The following steps will guide you through this installation process, assuming you are starting from scratch.
This guide provides a detailed walkthrough of the installation and setup process for VERA. If you prefer a quicker high-level overview, see the Quickstart section.
Step 1: install Unity
Unity is a cross-platform engine for creating virtual applications, which provides a variety of tools used to develop XR applications. VERA leverages these tools to facilitate data collection in XR experiments; if you are running an experiment on VERA, it must be built in Unity.
The VERA docs assume you have a basic understanding of Unity. If you are new to Unity, consider exploring the Unity Learn platform for tutorials and resources.
Install Unity:
Download and install Unity Hub from the Unity Download Page.
Open Unity Hub, and install any version of Unity (preferably LTS 6000.0 or later).
For more information on installing Unity, refer to the Unity Installation Guide.
Note
VERA officially supports Unity LTS versions 6000.0 and later. You may use other versions of Unity, but compatibility is not guaranteed.
Open a Unity project:
In Unity Hub, click on the New Project button.
Select the 3D template and name your project (e.g., “VERA Project”).
Click Create to open your new project in Unity.
If you already have an existing Unity project, you can skip this step and open your project directly in Unity.
For more information on creating a new project, refer to the Unity guide on new projects.
Step 2: install the VERA Unity plugin
The Unity-facing component of VERA is provided as a Unity package that can be imported into your Unity project. You’ll need to install this package to enable VERA functionality in your Unity project.
Install the VERA Unity plugin:
In the Unity editor, open the Package Manager by selecting Window > Package Management > Package Manager from the top menu bar.
In the Package Manager window, click on the + icon in the top left corner, and select Add package from git URL… (see the Unity manual on importing packages).
In the dialog that appears, enter the following URL and select Add:
VERA Package URL
Ensure proper import
VERA should now be installed in your Unity project. You should see a new folder named VERA in your Packages directory.
If you do not see this folder, ensure that the import was successful and that there were no errors during the import process.
This import process should additionally automatically install all necessary dependencies. Ensure these dependencies are installed correctly by checking the Package Manager in Unity. These dependencies are as follows:
XR Interaction Toolkit: For handling XR interactions.
VR Package: For VR support in Unity.
TextMeshPro (TMP) Essential Resources: For text rendering in Unity.
Step 3: authenticate your Unity project
To connect your Unity project to the VERA web portal, you need to authenticate your project with your VERA account.
Log in to the VERA portal:
Open your web browser and navigate to the VERA Portal.
If you do not have an account, create one by clicking on Sign Up and following the instructions.
If you already have an account, log in with your credentials.
Authenticate your Unity project:
If you have properly installed the VERA Unity plugin, a “VERA” tab will appear in Unity’s menu bar. Open it and select Settings.
This will open a VERA Settings window. This window will be used to manage a variety of settings related to VERA, including authentication and experiment selection.
In this window, click Authenticate. This will open a web browser to the VERA web portal.
This new browser window will automatically link your Unity project to your VERA account.
Ensure you are logged in:
After authenticating, return to Unity and ensure that the VERA Settings window shows your account information.
If you see your account information, you are successfully authenticated.
Next steps
Now that you have completed the installation and setup process, you are ready to start using VERA! Next, consider exploring the Sandbox Demo section to see a walkthrough of VERA’s features. After this, consider exploring some of VERA’s core functionality:
Explore the Unity plugin: overview section for more details on how to use the VERA Unity plugin.
Explore the Web interface: overview section for more details on how to use the VERA web portal.