Skip to content

Latest commit

 

History

History
137 lines (94 loc) · 8.09 KB

metaxr.md

File metadata and controls

137 lines (94 loc) · 8.09 KB
Raw

Meta XR Plugin / Meta Quest Set Up Guide

Requirements

Meta XR Plugin version

  • Minimum Meta XR Plugin: 53.0

Unreal version

  • Minimum Unreal version: 5.1

HISPlayer SDK version

  • Minimum HISPlayer SDK version: 2.2.0 with Vulkan support.

Supported Android Version

  • Minor version - Android 12
  • Recommended SDK: 32
  • Recommended NDK: 25.1.8937393
  • Recommended JDK: JDK 11

Install the Oculus PC app for Meta Quest Link app for Windows

Setup your Meta Quest device on your Windows system, by downloading the app for Meta Quest link. You can follow the official guide.

You may also use Meta Quest Developer Hub.

Unreal 5 and Meta XR Plugin Integration

First, please configure your Unreal engine version for Meta Quest by installing the Unreal 5 Meta XR Plugin into your engine.

Please, select the MetaXR version corresponding to your UE version

You can refer to any of the following guides for the Meta XR Plugin set-up for your project:

HISPlayer VR Sample

Download the Sample

Please, download the sample here: HISPlayer VR Sample (no need to download it if you have received it in the email).

Import HISPlayer SDK

Please use HISPlayer SDK v2.2.0 and above with Vulkan support.

If you have not imported HISPlayer SDK yet, please follow the Setup Guide. Extract the SDK from the .zip file, copy the HISPlayer folder and paste into the HISPlayerVRSample\Plugins directory.

The HISPlayer SDK plugin default UE version is 5.1. If you want to update it to a higher UE version, please do the following:

  • Update the Plugins/HISPlayer/HISPlayer.uplugin file with the Engine Version you will be using. For more information, refer to the setup guide.

Using the Sample

The HISPlayer VR Sample default UE version is 5.1. If you want to update it to a higher UE version, please do the following:

  • Right click on the HISPlayerVRSample.uproject file, select the option "Switch Unreal Engine Version" and select your UE version.

Open HISPlayerVRSample.uproject. Once the project is opened, you should be inside the HISPlayerVRLevel map. You can select other level such as HISPlayerVRLevelMultistream from ContentBrowser -> HISPlayerResources -> Levels.

image

To build for Meta Quest, you should configure your Android platform setting by following official guide from Meta: Configure the Project for Meta Quest Development or follow below steps:

  • Go to Edit > Plugins and select the Virtual Reality section.
  • Enable the Meta XR plugin.

image

  • Choose restart editor on the prompt.
  • Select the Meta XR tools button then Project Setup Tool to open the Project Setup Tool.

image

  • Select Apply All for Required and Recommended Rules for all devices you are targeting.

image

  • Restart the editor after applying settings. Note: This may require multiple restarts after applying a setting.

Input the license key that is associated with the SDK. If the license key is not valid, the player won’t work and will throw an error message. To find this field, go to the Level Outliner and look for the HISPlayer_Blueprint actor. Then, on the Details window, look for the HISPlayer section.

Then, package the project for the Android Platform, or deploy for your Quest device, in case it is connected to your PC through the Meta Quest Link App.

image

Sample Description

The HISPlayer VR Sample is made based on the Unreal Engine Virtual Reality Template

The important UI components are located in HISPlayerVRSample\Content\HISPlayerResources\UI:

  • HISPlayer_UI.uasset: Widget Blueprint of the video playback control UI
  • HISPlayer_UI_Actor.uasset: Blueprint class to place the HISPlayer_UI widget to VR space. The HISPlayer_UI is attached as a widget component.
  • HISPlayer_UI_OnClick.uasset: Represents an abstract game action for HISPlayer_UI that can be mapped to Meta Quest left and right hand controllers

image

The HISPlayer UI components are connected to the default VRTemplate's device input action mapping (IMC_Default) and Blueprint class (VRPawn) :

  • HISPlayerVRSample\Content\VRTemplate\Input\IMC_Default.uasset: The HISPlayer_UI_Onlick is mapped in this input mapping context asset. It represents the Meta Quest left and right hand controllers input action for HISPlayer_UI.

image

  • HISPlayerVRSample\Content\VRTemplate\Blueprints\VRPawn.uasset: a Pawn is the physical representation of the user and defines how the user interacts with the virtual world. In the VR Template, the Pawn contains the logic for input events from the motion controllers. You can also control the behavior of Meta Quest left and right hand controller through WidgetInteractionLeft and WidgetInteractionRight. The Blueprint also controls the UI interaction with the Meta Quest left and right hand controllers emulating the left-mouse click.

image

HISPlayer 360 Video VR Sample

Download the Sample

Please, download the sample here: HISPlayer 360 VR Sample (no need to download it if you have received it in the email).

Import the SDK and using the Sample

To import the SDK and use the sample, please follow the same steps to set the HISPlayerSDK and the MetaXR Unreal plugins as in the regular HISPlayer VR Sample.

You can find the HISPlayerVR360Level map in ContentBrowser -> HISPlayerResources -> Levels.

Once the previous steps have been completed, you need to set the HISPlayer_Mat material to be able to render both in the outside and inside faces of the sphere. To do that, go to ContentBrowser -> Plugins -> HISPlayer Content -> Resources -> HISPlayer_Mat. Open the material editor, open the window Details of the HISPlayer_Mat node, go to Material and check the Two Sided checkbox option.

image

Now you will be able to render 360 video into the interior of the Sphere actor. To package the project for a Meta XR device, please follow the same instructions as in the regular HISPlayer VR Sample.