Skip to content

How To Set Up VeRidium

Jump to bottom
Julian Arnold edited this page Sep 13, 2024 · 1 revision

In order to be able to contribute, you should first be able to create your own Build of VeRidium. This guide will help you with getting there.

Prerequisites

You will need Unity Hub installed. The experience is designed to run on the Oculus Quest 2. Follow these instructions as necessary to configure the Quest (if not already configured), and Unity Hub. However, the article is a bit outdated so only follow the instructions up to "Install and run Unity". If you do not have an Oculus developer account, you will need to follow these instructions to create one. For configuring the build, player, and XR settings, refer to this instead.

Development Setup Instructions

  1. Fork or clone this project repository using git to a local space. In most cases, you will want to fork.
  2. Open Unity Hub and open the project that you have cloned, if prompted, install the correct version of Unity (2020.3.2f1) to use for development. Make sure to you include Android Build Support (Check the corrsponding box when asked for which platforms to include) with your installation of Unity.
  3. In File>Build Settings, if the development platform is not Android, click Android and then Switch Platform. Follow these instructions to configure your build settings. This might take a while, so be patient.

The Oculus plugin is already in the repository, and therefore does not need to be specially installed.

Building and Running

To build, connect the Oculus Quest to the computer via USB.

If ADB (Android Development Bridge, included in Android Studio) has been properly installed, you will be able to select the device in File/Build Settings. From there, you may Build and Run.

If you choose just the Build option, this will create an apk file that will be saved onto your computer. Using the command line, navigate to the location where the file has been saved and type adb install -r [yourFilename].apk. This will load the project onto your Quest, which can be found under Unknown Sources part of your Quest library. Alternatively, you can use SideQuest for a Graphical User Interface.

If everything runs, you are now done and ready to get started!

Any problems? Ask us, we can help you!

Clone this wiki locally