Skip to content

The prototype game developed during the seventh semester group project at Medialogy @ Aalborg University

License

Notifications You must be signed in to change notification settings

Jia-WeiFang/open-source-stream-VR-game

 
 

Repository files navigation

Umqombothi

The following is a guide on how to set up our prototype game "Umqombothi". If you have any questions regarding anything in this document, please reach out to us as soon as possible!

Prerequisites

Please start by making sure you have the latest graphics drivers for your system. How to check and update this depends on the manufacturer of your computer:

Next, please download our game from our releases page on the GitHub repo (you specifically need to download and extract the “build_1_0_1.zip” file).

Installing Oculus Link

To be able to run the prototype, you will first need to install Oculus Link, enabling the connection between your computer and the virtual reality headset.

Note that you must download and install the version of the software that is intended for your specific headset. You can find software for the Oculus Quest 2 and Oculus Rift S here.

For the software to work, you must sign in through a Facebook account. We cannot provide you with one, but you should be able to use any existing account.

Once you’re signed in, you just need to have the software open and plug in the headset with the Oculus Link Cable.

Installing SteamVR

Our solution is built on SteamVR, a virtual reality framework built on the OpenVR standard, made to support a very broad set of virtual reality equipment.

To get SteamVR, you must first download and install Steam, this site will guide you through the process. If you do not already have Steam installed, the site will redirect you to the steam download page.

When you have Steam installed, you must create an account or log in to an existing one. We will not be able to provide you with an account, but it is free to create one.

Once you’re signed in to your Steam account on the client, please download SteamVR through this link.

Running the prototype for the first time

Once you have SteamVR installed, you...

  1. Make sure your PC is plugged in while running the simulation for best performance.
  2. start up the Oculus Rift S (or the VR headset you are using),
  3. plug it into your computer with the Oculus Link Cable,
  4. launch SteamVR,
  5. unzip the compressed file “build_1_0_2.zip”,
  6. open the uncompressed folder of the same name,
  7. double-click on the “Umqombothi” executable.

Our prototype should now launch through SteamVR and play through the Rift S. Please verify that this is the case, then exit SteamVR again.

Testing the game in the Unity Editor

Some of the unit tests make use of an external c# library, which you must download and put into the Assets folder for the project to compile.

The game has a DebugPlayer, which you can trigger when running the game in the Unity editor and pressing one of the WASD movement keys. When triggered, you can move around the level with said keys and look around with the mouse. To interact with object, hold fown F and point on the screen where you want to simulate a VR grabbing action (there is a range limit to this). When playing through the game in this mode, Tasks related to moving objects around the scene are skipped.

About

The prototype game developed during the seventh semester group project at Medialogy @ Aalborg University

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 97.7%
  • ShaderLab 2.3%