Documentation Home
Documentation Home
Breadcrumbs

How to install / deploy UE extension

How to Install / Deploy UE Extension

Packaging Your Extension

To use an extension inside Skyreal VR, it must first be packaged (cooked).

  1. Cook the project: Platforms > Windows > Cook Content.

[IMAGE: Cook content menu — original at /pictures/v1.16/PackageExtension_Step0.png]

  1. Wait for the cooking process to complete. A popup confirms success.

[IMAGE: Cooking in progress — original at /pictures/v1.16/PackageExtension_Step1.png]

[IMAGE: Cooking success — original at /pictures/v1.16/PackageExtension_Step2.png]

  1. Copy the {PluginName}.uplugin file from your project's Plugins/{PluginName}/ directory.

  2. Paste it into the cooked output folder: {YourProject}\\Saved\\Cooked\\Windows\\{YourProject}\\Plugins\\{PluginName}\\.

[IMAGE: Uplugin file copy — original at /pictures/v1.16/PackageExtension_Step3.png]

  1. (Optional) Extract the plugin to a standalone directory by copying {YourProject}\\Saved\\Cooked\\Windows\\{YourProject}\\Plugins\\{PluginName} to any output location.

Deploying Extensions into Skyreal VR

There are four methods to load an extension:

Method 1 — SkrExtensions.json (Startup)

Edit the SkrExtensions.json file in the Skyreal VR directory. Reference extensions in the plugins JSON array, using either full or relative paths.

[IMAGE: SkrExtensions.json configuration — original at /pictures/v1.16/RegisterExtension_Option0.png]

Method 2 — Command Line Argument (Startup)

Pass the path to an extensions JSON file as a startup argument:

-extensions="c:/{YourPath}/{filename}.json"

Method 3 — Load at Runtime via Command

Add the Load Extensions command to the desktop menu. When clicked, a file picker opens for selecting the .uplugin file.

[IMAGE: Load extensions command — original at /pictures/v1.16/RegisterExtension_Option2.png]

Method 4 — Load at Runtime via Blueprint

Call TryLoadExtensionsFromFile in the SkrExtensionsSubSystem from your blueprint code.

[IMAGE: Blueprint runtime loading — original at /pictures/v1.16/RegisterExtension_Option3.png]

Marketplace Deployment

For centralized deployment across your organization, use the Marketplace flow. See the Marketplace Installs page for details on deploying extensions through XR Center.