Decommissioned

Decommissioned is a social deduction VR game that showcases the use of the Meta XR SDK, the Meta Interaction SDK, and the Meta Avatars SDK to create a social VR gaming experience.

This codebase serves as a reference and template for multiplayer VR games. You can play it on Meta Quest via the Horizon Store - Decommissioned.

Project Description

This project is a social deduction game for Meta Quest devices, playable with friends or strangers. It demonstrates how to connect users in random games or private rooms and invite friends to matches using the Meta Platform SDK.

Players use Meta Avatars to represent their VR personas, and Photon Voice for communication. The game uses Application SpaceWarp to maintain a stable framerate.

How to Run the Project in Unity

1. Configure the project with Meta Quest and Photon.

2. Use Unity 6000.0.50f1 or newer.

3. Load the Assets/Decommissioned/Scenes/Startup scene.

4. To test in the Editor, choose one of the following:

   Quest Link

   • Enable Quest Link:
     • Put on your headset, go to "Quick Settings", and select "Quest Link" (or "Quest Air Link" if using Air Link).
     • Select your desktop from the list, then select "Launch". This opens the Quest Link app, allowing desktop control from your headset.
   • With the headset on, select "Desktop" from the control panel in front of you. You should 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. To use the mouse in-game (such as to interact with menus), hold Left Alt.

Dependencies

This project uses the following plugins and software:

• Unity 6000.0.50f1 or newer
• Meta Avatars SDK
• Meta XR Audio SDK
• Meta XR Core
• Meta XR Integration SDK
• Meta XR Platform SDK
• Unity Universal Render Pipeline (ASW fork)
• ParrelSync
• Photon Realtime for Netcode
• Photon Voice 2
• Unity Netcode for GameObjects
• Unity Toolbar Extender
• ScriptableObject-Architecture
• NaughtyAttributes

To test this project within Unity, you need:

• The Meta Quest App

Getting the Code

First, ensure you have Git LFS installed by running:

git lfs install

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

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

Documentation

More information is available in the Documentation section of this project.

• Armbands
• Avatars
• Code Structure
• Configuration
• Multiplayer

Custom 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.

Meta Avatar SDK and Photon Packages

The Photon Voice 2 package is stored in the Packages folder. To update them, import their updated Asset Store packages, then copy them into their respective Packages folders.

We use the Ultimate GloveBall fork of Photon Realtime for Netcode.

License

Most of Decommissioned is licensed under the MIT LICENSE. However, files from Text Mesh Pro, and Photon Voice are licensed under their respective terms.

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 MIT License applies.

Contribution

See the CONTRIBUTING file for information on how to contribute.