search

Ayushanbhore / Unreal-Quest3-PassthroughSample

A sample to create your own Unreal Passthrough Project for Meta Quest 3, Meta Quest Pro. Works with Meta Quest 2 but it is not recommended. Use it to learn Unreal Engine
51 stars 11 forks source link
ayushanbhore depth-api mesh-api meta-quest-3 oculus-quest-2 oculus-quest-3 passthrough-api quest3 quest3d unreal unreal-engine-5 unreal-engine-sample unreal-passthrough unrealengine5

readme

Unreal-Quest3-PassthroughSample

This repository contains a sample Unreal Engine project demonstrating how to integrate and utilize the Passthrough, Depth API, and Mesh API for the latest Oculus Quest 3 device. This project serves as a reference for developers looking to create immersive Augmented Reality / Mixed Reality Experiences using Unreal Engine on the Oculus Quest 3 platform.

Table of Contents

Overview

This sample project showcases the integration of Passthrough, Depth API, and Mesh API provided by Oculus for the Meta Quest 3 VR headset within the Unreal Engine 5.1.1 environment. It demonstrates how to access and utilize real-time camera feed (passthrough), depth information, and mesh data to create AR experiences in the Unreal Engine environment for Oculus Quest 3 and also for Oculus Quest Pro

Getting Started

Prerequisites Before using this sample project, make sure you have the following prerequisites installed and set up:

Prerequisites

Installation

  1. Clone this repository to your local machine:
git clone https://github.com/ayushanbhore/Unreal-Quest3-PassthroughSample.git

  1. Open the project in Unreal Engine. Works Best with Unreal Engine 5.1.1 and later

  2. Download the MetaXR Plugin for your Engine

-> Preferably - 54.0 Version

https://developer.oculus.com/downloads/package/unreal-engine-5-integration

  1. It is recommended to place the MetaXR Plugin in the Marketplace Folder inside your Unreal Engine Directory

  2. Launch Unreal Engine and Make Sure to Tick these Plugins in the Plugins Section

    -> Please Uncheck Oculus VR Plugin or it may cause issues

  3. Copy these settings in the Project Settings -> Plugins -> MetaXR -> Mobile Section of you Unreal Engine

Usage

Follow these steps to run the sample project and explore the integration of Passthrough, Depth API, and Mesh API:

  1. Connect your Oculus Quest 3 device to your Development machine using a Link ( Link Cable Recommended over the Air Link).

  2. Build and Deploy the project to your Oculus Quest 3 device using Unreal Engine.

  3. Put on your Oculus Quest 3 headset and experience the augmented reality environment created using Passthrough.

License

This sample project is licensed under the MIT License. Feel free to modify and distribute it according to the terms of the license.