Meta Developers

Develop

Develop

Select your platform

Setting up your dev environment

Installing Unreal Engine

Installing Android Studio

Installing the Meta XR Plugin

Configuring your headset

Choosing UE installation by feature compatibility

PC-VR Integration for Unreal Engine

Setting up your first project

Configuring the Meta XR plugin

Choosing an OpenXR Backend

Packaging your new project

Meta XR plugin settings

Unreal Engine Royalty Payment Program

Add user input and interactions

Getting Started

Interaction Lifecycle

Grabbing Objects

Grab Interactions

Hand Grab Poses

Custom Distance Grab Visuals

Custom Ray Grab Visuals

Playing Sounds for Interactions

Troubleshooting

Feature Walkthrough

Troubleshooting

Troubleshooting

Other Runtime APIs

Add Realism using Movement SDK

Getting Started

Code Walkthrough

Movement Sample

Advanced Material

Troubleshooting

Morph Target Visual Reference

Body Joints Visual Reference

Integrate Voice Features

Integrating Voice SDK

Enabling Voice Commands

Setup Voice Command

Redirecting the Wit Endpoint

Versioning Your App

Providing Voice Transcriptions

Providing Visual Feedback

Live Understanding

Enabling Dictation

Using Text-to-Speech (TTS)

TTS Voice Customization

TTS Cache Options

Troubleshooting

Custom User Input Mapping

Enable controllers

Getting Started

Creating a Distance Grab Interaction

Controller Input Mapping

Oculus Touch Controller

Touch Plus Controllers

Controllers Best Practices

Controllers Troubleshooting

Enable Hand Tracking

Set Up Hand Tracking

Add Spatial Audio

Integrate Mixed Reality

Use Mixed Reality Utility Kit

Passthrough Relighting Sample

Add Real-World View with Passthrough

Create Depth Perception

Troubleshooting and FAQ

Spatial Data Permissions

Semantic Labels for Scenes

Migrate to MR Utility Kit

Get Started with Scene Actor

Importing Scene Entity Meshes

Blueprint Reference

Using Spatial Anchors

Getting Started

Spatial Anchors

Shared Spatial Anchors

Colocation Discovery

Troubleshooting

Blueprint Reference

Mixed Reality Experience and Use Cases

Platform Solutions

Getting Started Guide

Server-to-Server API Basics

Set Up for Platform Development

Multiplayer Features

Multiplayer Overview

Multiplayer Enablement

Testing and Use Cases

App to App Travel

Invokable Error Dialogs

SharedSpaces Multiplayer Showcase

Multiplayer Testing

Multiplayer Testing with Link

Multiplayer Testing with link and Meta XR Simulator

Multiplayer Testing Tool

User Engagement

User Engagement Overview

User Notifications

Create User Notifications

Event-Based Notifications

Developer Posts

Leaderboards Client APIs

Leaderboard Server APIs

Challenges Client APIs

Challenges Server APIs

Share Content from Apps

Monetization Overview

Add-ons - Downloadable Content and In-App Purchases

Add-ons Integration

Add-on Server APIs

Testing Add-ons

Server APIs for Subscriptions

Social Features

Social Features Overview

Parties and Party Chat

Parties and Party Chat

User Info, Friends and Relationships

Verify the User

Enable Friend Requests (Mobile)

Managed Accounts

Managed Account API Overview

User Management

User Management Overview

Entitlement Check

Account Linking

Security Overview

Attestation API

Get Age Category API

Lying Down Mode

Quest Tools Overview

Asset Files to Manage Download Size

App Deep Linking

System Deep Linking

Save Game Best Practices

Cross-Device Development with App Groupings

Platform Reference

Platform Release Notes Archive

Display and Rendering Capabilities

Fixed Foveated Rendering

Eye Tracked Foveated Rendering

Set Display Refresh Rates

Enabling Phase Sync Adaptive Frame Timing

Enabling Late Latching

Unreal Forward Shading Renderer

Adaptive Pixel Density

VR Compositor Layers

Layer Filters - SuperSampling and Sharpening with MQSR

Color Space and Color Scaling

Material shader statistics with Adreno Offline Compiler

Performance and Optimization

Building and Packaging Apps

Iteration Speed Best Practices

Reduce App Deploy Time During Development

Improve Compile Times with FASTBuild

Testing and Automation Tools

Use Meta Quest Scriptable Testing Services to Enable E2E Testing

Using AutoDriver to Record Inputs

Using Oculus Debugger for VS Code

Vulkan Validation Layers

Testing and Performance Analysis

PC-VR - Testing and Performance Analysis

Enhance the User Interface

Overlays and Input Focus

Enable Keyboard Overlays for Text Input

Mixed Reality Capture

Creating without a Boundary

Social Applications and Revenue

Publish Your App

Unreal Engine Royalty Payment Program

Set Target Device and Get Device Type at Runtime

Upload App to Meta Horizon Store

Meta XR Plugin Settings

Developer Tools

Using Link for App Development

Meta XR Project Setup Tool

Meta XR Mixed Reality Template

Meta Quest Developer Hub

Manage Your Headset

Set Up Headset with MQDH

Debugging Tools

Create Custom Command

Performance Analyzer

How to Take Perfetto Traces

Layer Visibility Control

Explore File Manager

Add, Remove, and Switch Between Multi-User Accounts

Deploy Build on Headset

Troubleshooting MQDH

Submit and Track Bugs and Feature Requests

Collect VrApi Logs with Logcat

Logcat Stats Definitions

Configure Android System Properties

Use ADB with a Headset

Performance Tools

Unreal Insights

RenderDoc Meta Fork

Taking and Loading a Capture

Performing a Render Stage Trace

Performing a Draw Call Trace

Accessing Vulkan Shader Stats

Recommended Settings

Draw Call Metrics

OVR Metrics Tool

OVR Metrics Tool Stats Definition Guide

Best Practices - OVR Metrics Tool for Non-Engineers

Meta XR Simulator

Samples and Showcases

Unreal Showcases

Train Hand Tracking Sample

Shared Spatial Anchor

Blueprints Reference

Color Management

Get Hmd Color Desc

Set Client Color Desc

Set Color Scale and Offset

Get Guardian Dimensions

Get Guardian Points

Get Node Guardian Intersection

Get Play Area Transform

Get Point Guardian Intersection

Is Guardian Displayed

Set Guardian Visibility

Get Hand Skeletal Mesh

Get Dominant Hand

Get Bone Rotation

Get Pointer Pose

Initialize Hand Physics

Is Pointer Pose Valid

Is Hand Tracking Enabled

Get Controller Type

Get Oculus MR Settings

Get Tracking Reference Component

Set Tracking Reference Component

Overlay and Dash Blueprints

Has Input Focus

Add Passthrough Layer Component

Add Static Surface Geometry

Remove Static Surface Geometry

Add Procedural Surface Geometry

Remove Procedural Surface Geometry

Enable Color Map

Enable Edge Color

Set Color Map Curve

Set Color Map Type

Set Edge Rendering Color

Set Texture Opacity

Performance Optimization Blueprints

Get Available Display Frequencies

Get Current Display Frequency

Set Display Frequency

Get GPU Frame Time

Get GPU Utilization

Set CPU and GPU Levels

Position and Orientation

Enable Orientation Tracking

Enable Position Tracking

Get Base Rotation and Base Offset in Meters

Get Raw Sensor Data

Is Device Tracked

Set Base Rotation and Base Offset in Meters

Add Loading Splash Screen

Clear Loading Splash Screen

Enable Auto-Loading Splash Screen

User, Device, and Account

Get Device Type

Get User Profile

Verify User Entitlement

Console Command Reference

Experimental Features

Retired Blueprints

Has System Overlay Present (Retired)

Oculus Avatars (Retired)

Overview (Retired)

Avatars Upgrade Guide (Retired)

Avatar Developer Guide (Retired)

Expressive Features for Avatars (Retired)

Avatar SDK Developer Reference (Retired)

Avatars After 4.26 Unreal Engine (Retired)

Oculus VST Spatializer for DAWs Integration Guide (Retired)

Overview (Retired)

Use the Oculus Plugin (Retired)

VST Options and Parameters (Retired)

3D Visualizer (Retired)

DAW-Specific Notes (Retired)

Legal Notifications (Retired)

Oculus AAX Spatializer for DAWs Integration Guide (Retired)

Overview (Retired)

Use the Plugin (Retired)

Track Parameters (Retired)

3D Visualizer (Retired)

Archived Platform Solutions

Matchmaking (Deprecated)

Introduction to Matchmaking (Deprecated)

Matchmaking API (Deprecated)

Implement Matchmaking (Deprecated)

Refine Matchmaking (Deprecated)

Test and Tune Matches (Deprecated)

Peer-to-Peer Networking (Deprecated)

Group Launch (Deprecated)

Rooms (Deprecated)

Rooms Client APIs (Deprecated)

Server APIs for Moderated Rooms (Deprecated)

Voice Chat (VoIP) (Deprecated)

Oculus Audio for Unreal Apps

Archived Developer Tools

GPU Systrace (Deprecated)

Cloud Saves API (Deprecated)

Cloud Saves Deprecation

Console Commands and Variables Reference

This document reviews useful Unreal Engine console commands and console variables available for Meta Quest development.

Typically, you open the console by pressing the ~ (tilde) key. However, opening the console window in Unreal varies by operating system and configuration, so you should consult the Unreal Engine documentation.

For a list of all commands, you can type dumpconsolecommands in the console.

Unreal Engine VR Commands

Following are some commands for general VR development.

Task	Console Command
Prints the version info for the current device	`vr.HMDVersion`
Enable or disable the HMD	`vr.bEnableHMD [bool]`
Enable or disable Stereo mode	`vr.bEnableStereo [bool]`
Change world units to meters scale	`vr.WorldToMetersScale [float]`
Enable or disable the hidden-area mask	`vr.HiddenAreaMask [bool]`
Set screen mode	`vr.SpectatorScreenMode [0..5]` where 0=Disabled, 1=SingleEye Letterboxed, 2=Undistorted, 3=Distorted, 4=SingleEye, 5=SingleEye Cropped
Set tracking origin to floor or eye	`vr.TrackingOrigin [floor/eye]`
Reset the position and orientation and apply yaw in degrees	`vr.HeadTracking.Reset [yaw]`
Reset position only	`vr.HeadTracking.ResetPosition`
Reset orientation only and apply yaw in degrees	`vr.HeadTracking.ResetOrientation [yaw]`
Shows current head tracking status	`vr.HeadTracking.Status`

Meta Quest Commands

The following are some commands specific to Quest VR development.

Task	Console Command
Launch the Quest Perfomance Window	`vr.oculus.ShowToolWindow`
Initiate a CPU stress test	`vr.oculus.Stress.CPU [PerFrameTime [TotalTimeLimit]]`
Initiate a GPU stress test	`vr.oculus.Stress.GPU [LoadMultiplier [TimeLimit]]`
Reset the stress tester and stop all currently running stress tests.	`vr.oculus.Stress.Reset`

Meta Quest Mixed Reality Commands

The following are some Quest mixed-reality commands. Note that Chroma key settings allow for fine-tuned control of how the video and application streams are composited. Use these settings to set the reference color of the green screen and control various thresholds at which video pixels are included or excluded from the final frame.

Task	Console Command
Set the composition to post-process meaning the casting window includes the background and foreground view.	`oculus.mr.ExternalCompositionPostProcess`
Override the parameters with the specified values.	`oculus.mr.OverrideParameters [0,1]`

Command-line Parameters for Mixed-Reality Sample

Once you package the sample scene, you may launch it with the parameters listed in the following table. You may set your application to launch with mixed reality capture enabled in Blueprints for debugging purposes only. The Blueprint setting bCastingAutoStart is automatically disabled when you build your package.

Task	Console Command
Launch in direct composition mode with MirrorWindow projection. In this case the Quest MR Output window would get minimized automatically	`-mxr_project_to_mirror_window`
Launch in MultiView mode	`-mxr_open_multiview`
Automatically open the Quest MR Output window in the DirectComposition mode	`-mxr_open_direct_composition`

Did you find this page helpful?