Documentation Home
Documentation Home
Breadcrumbs

Getting started – UE Dev environment

Getting Started — UE Dev Environment

To create Skyreal VR extensions, you need an installed version of Unreal Engine compatible with your Skyreal VR release and the Skyreal VR SDK plugins.

Prerequisites

  • Unreal Engine — Version matching your Skyreal VR release (currently UE 5.6)

  • Skyreal VR SDK Plugins — SkrSdk, SkrUtility, SkrDataModel (and others as needed)

Setting Up Your Project

You can start from one of two options:

Option A — Start from a DataPrep Map

Use a dataprep map created by SkyPrep or CAD Forge. This gives you a working project with all Skyreal VR plugins already configured.

Option B — Create a New Project

  1. Create a new Unreal Engine project.

  2. Download all Skyreal VR plugins from the release package.

  3. Copy the plugins into your project's Plugins directory.

  4. Configure Skyreal VR rendering options.

Creating Your First Extension Plugin

  1. Open your project and go to Edit > Plugins.

[IMAGE: Plugins menu — original at /pictures/v1.16/CreateExtension_Step0.png]

  1. Click Add at the top left of the Plugins tab.

[IMAGE: Add plugin button — original at /pictures/v1.16/CreateExtension_Step1.png]

  1. Select Content Only and enter your plugin name.

[IMAGE: Plugin creation dialog — original at /pictures/v1.16/CreateExtension_Step2.png]

  1. A new folder appears in the Plugins section of the Content Browser. If you don't see it, check that Show Plugin Content is enabled in the Content Browser Settings menu.

  2. Create a RegistrableAssets directory inside your plugin content folder. All extension data assets should be saved here.

[IMAGE: RegistrableAssets directory — original at /pictures/v1.16/CreateExtension_Step3.png]

Skyreal VR SDK Overview

The Skyreal VR SDK (SkrSdk plugin) exposes internal data models and functions to blueprints. It depends on SkrDataModel and SkrUtilities.

To explore available SDK functions, use the Unreal blueprint search system and look for the SkrSdk category.

[IMAGE: SDK search in blueprints — original at /pictures/v1.16/SkrSdk_Search0.png]

Key SDK Classes

Class

Description

SkrSdkGameState

Manages non-replicated behavior. Contains Group Manager, Isolation Manager, and Virtual Product Structure Manager

SkrSdkGameInstance

Stores session properties (rendering, user info, map info). Mostly boot-time information

SkrSdkPawn

Represents one user. Contains body, manikin, and controller references

SkrSdkPlayerController

Represents user behavior. Contains Navigation, Desktop UI, VR Manager, Selection Manager, Command Manager, and Input Manager

[IFRAME: SkrSdkGameState blueprint sample — original at https://blueprintue.com/render/wm770nj5/]

[IFRAME: SkrSdkGameInstance blueprint sample — original at https://blueprintue.com/render/ue-s800u/]

[IFRAME: SkrSdkPawn blueprint sample — original at https://blueprintue.com/render/8un5c4dm/]