0.0.1

You are viewing an older version of this document (Version 8). The latest is Version 21.

Last updated: 10 months ago • 21 versions | Visibility: Public

Context

This OpenXR-based SDK allows Unreal Engine 5 users to develop their own applications for the Lynx-R1 headset.

Requirements

Android Studio

You need to install Android Studio and set it up correctly.

Start Android Studio, click on More Actions > SDK Manager > SDK Tools, (check "Show Package Details"), install the following components:

Android SDK Build-Tools 28.0.3 and/or 29.0.3
Android NDK 21.1.6352462
Android SDK Command-line Tools (latest)
CMake 3.18.1

Android Studio should be set up correctly.

.NET Framework

You need to install following components:

Java Standard Edition (Java SE)

You need to install following component:

Java SE 8 Development Kit 8u241 (JDK)

Disclaimer: not to confuse with JRE.

Unreal Engine

You need to install Epic Games Launcher, and add an Enigne Version in Library tab:

Unreal Engine 5.0.3

Get Started

Create a Project

Create a project using the Unreal Engine "Virtual Reality" template (check "Starter Content").

When the project is launched, press the Edit tab, then Project Settings. A window will open, scroll down to find the Platforms section and click on Android SDK.

Fill in the paths to point to the SDK, NDK and JDK you downloaded in the requirements section.

Lynx Plugin

Add the Lynx plugin to the following directory (you may need to create the Plugins folder): YourProject/Plugins

Restart your project to update the list of your plugins.

You can now package your project for Android to get a first look.

Handtracking

We recommend to use UltraleapTracking 4.8.0 plugin, which you can find here: https://github.com/ultraleap/UnrealPlugin/releases/

Add the Ultraleap plugin to the following directory (you may need to create the Plugins folder): YourProject/Plugins

Restart your project to update the list of your plugins.

Then add one of the four hand blueprints available in your Content Browser: Plugins/Ultraleap Tracking Plugin Content/HandModules/Hands

Make sure your hands are correctly positioned at Player Start that the target version of the SDK is 28+.

Android Permissions

To be launched from Lynx Home, your application must have certain permissions, which must be added from Unreal Engine.

Open Project Settings, in the Advanced APK Packaging section, add the following two Extra Permissions:

org.khronos.openxr.permission.OPENXR_SYSTEM
org.khronos.openxr.permission.OPENXR

Video Passthrough

Work in progress.