Project Phanto - Presence Platform Reference App

Project Phanto is a Mixed Reality (MR) reference app that highlights the latest Presence Platform features, such as scene mesh, Scene Model, and Scene API objects.

This codebase serves as a reference and template for MR projects. You can test the experience by building and deploying it to your Meta Quest device.

Project Description

This project showcases scene mesh functionality, Scene Model integration, Scene API objects, haptic feedback, and mixed reality navigation systems.

Built using the Unity engine with Unity 6 or higher, it includes haptic assets designed with Haptics Studio and integrated using the Haptics SDK for Unity.

How to Run the Project in Unity

1. Use Unity 6 or higher.
2. Load a Main Scene or Example Scene.
3. Choose one of three running options:

   • Quest 3: Build, deploy, and run the game on your headset.

   • Oculus Link (Windows only):

     Oculus Link

     • Open the Oculus app and run Oculus Link from the headset.
     • Select Scene Api as the Scene Data Source in SceneDataLoaderSettings.asset.
     • With the headset on, navigate to Unity and press "Play".
     • Note: Scene mesh and room elements will show up in Link. You can only trigger room scan from within the headset.

   • Static Mesh: Select Static Mesh Data as the Scene Data Source for development without Scene Model on headset.

Dependencies

This project uses the following plugins and software:

• Unity 6 or higher
• Meta XR Interaction SDK OVR Integration v67
• Haptics Studio
• Haptics SDK for Unity
• XRGizmos
• Graphy

To test this project within Unity, you need:

• The Meta Quest App
• Mac or Windows

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-Phanto

Documentation

More information is available in the sections below:

• Health & Safety Guidelines
• Design Flow
• Device Compatibility
• Key Components
• Main Scenes
• Example Scenes

Device Compatibility

Device	Scene API	Color Passthrough	High res color	Scene Mesh	Haptics1
Quest 3	✔️	✔️	✔️	✔️	✔️
Quest Pro	✔️	✔️	❌	❌	✔️
Quest 2	✔️	❌	❌	❌	✔️

1: There have been significant improvements in the haptics capability of Quest Pro and Quest 3 controllers over Quest 2: Quest Pro and Quest 3 introduce TruTouch haptics, enabling a new level of immersion in your applications. For more information, visit our Haptic Design Guidelines.

License

This codebase is available as both a reference and a template for mixed reality projects.

Most of Phanto is licensed under the MIT License; however, files from Text Mesh Pro are licensed under their respective terms.

Dependencies Licenses

XRGizmos is sourced from https://github.com/darktable/XRGizmos.git. The License for XRGizmos can be found here.

Graphy is sourced from https://github.com/Tayx94/graphy.git. The License for Graphy can be found here.

Contribution

See the CONTRIBUTING file for information on how to contribute.