Decommissioned

Decommissioned was built to demonstrate how to use the Oculus Integration SDK, the Meta Interaction SDK, and the Meta Avatars SDK to create a social gaming experience in VR.

This codebase is available both as a reference and as a template for multiplayer VR games. The Oculus License applies to the SDK and supporting material. The MIT License applies to only certain, clearly marked documents. If an individual file does not indicate which license it is subject to, then the Oculus License applies.

This project was built using the Unity engine with Photon Realtime as the transport layer and Unity Netcode for GameObjects.

You can play it on Meta Quest through App Lab.

Project Description

This project is an application for the Meta Quest devices that demonstrates a social deduction game that can be played with friends or strangers. It shows how to integrate connection between users joining random games or specific private rooms, and how to invite friends to specific matches using the Oculus Platform API.

Meta Avatars are integrated for players to represent their VR persona and Photon Voice voice chat for easy communication. The game is rendered using Application SpaceWarp to keep a stable framerate.

The project also contains the following reusable packages:

Meta Utilities - General utilities for game development.
Meta Input Utilities - XR FPS Simulator and other input-related utilities.
Meta Multiplayer for Netcode and Photon - Components for easily bootstrapping a multiplayer VR game, including networked Avatars.
Watch Window - Editor tool to help track and visualize data while in Play or Edit mode.

More information can be found in the Documentation section of this project.

How to run the project in Unity

Configure the project with Meta Quest and Photon
Make sure you're using Unity 2021.3.19f1 or newer.
Load the Assets/Decommissioned/Scenes/Startup scene.
There are two ways of testing in the editor:
Quest Link
- Enable Quest Link:
  - Put on your headset and navigate to "Quick Settings"; select "Quest Link" (or "Quest Air Link" if using Air Link).
  - Select your desktop from the list and then select, "Launch". This will launch the Quest Link app, allowing you to control your desktop from your headset.
- With the headset on, select "Desktop" from the control panel in front of you. You should be able to see your desktop in VR!
- Navigate to Unity and press "Play" - the application should launch on your headset automatically.
XR FPS Simulator
- In Unity, press "Play" and enjoy the simulated XR controls!
- Review the XR FPS Simulator documentation for more information.
  - Note: The mouse is captured by the simulator when in play mode. In order to otherwise use the mouse in-game (such as to interact with menus), hold Left Alt.

Dependencies

This project makes use of the following plugins and software:

Unity 2021.3.19f1 or newer
Meta Avatars SDK
Meta XR Utilities
Oculus Integration SDK: released under the Oculus SDK License Agreement.
Unity Universal Render Pipeline (ASW fork)
ParrelSync
Photon Realtime for Netcode
Photon Voice 2
Unity Netcode for GameObjects
Unity Toolbar Extender
ScriptableObject-Architecture
NaughtyAttributes

The following is required to test this project within Unity:

The Oculus App

Getting The Code

First, ensure you have Git LFS installed by running this command:

git lfs install

Then, clone this repo using the "Code" button above, or this command:

git clone https://github.com/oculus-samples/Unity-Decommissioned.git

Where are the Meta Avatar SDK and Photon packages?

In order to keep the project organized, the Meta Avatars SDK and Photon Voice 2 packages are stored in the Packages folder. To update them, import their updated Asset Store packages, then copy them into their respective Packages folders.

The Photon Voice 2 package is released under the License Agreement for Exit Games Photon.