Unreal StarVR Plugin

Introduction

StarVR One UE Integration

The StarVR One Plugin is designed to be as easy to integrate as possible. This document outlines a basic Plugin integration with the Unreal Engine. Many of the outlined code samples have been taken directly from the source code. These release notes describe changes to the StarVR One Plugin Distribution for Unreal Engine available from the StarVR One repository.
 
The StarVR One Plugin supports the following versions of the Unreal Engine : Unreal Engine 4.22, 4.23, 4.24
 

StarVR One Source Distribution

The StarVR One distribution of the Unreal Engine Plugin makes use of the latest StarVR One SDK and provides the most recent features. Access to the Plugin and SDK repository is available here.

- StarVR One Unreal Engine Plugin (Latest)

UE Distributions
The Unreal Engine is available as a binary from Epic Games (instructions here).
 
Unreal Engine Binary
For beginning developers, the Unreal Engine binary available through Epic’s Launcher is recommended. See the following link to obtain the UE binary : https://www.unrealengine.com/download
 

Introduction

The StarVR Unreal Engine Plugin is a collection of code and data content developers can easily enable or disable through the UE Editor. The Plugin can add functionality, such as runtime, to modify Engine features to extend content through the StarVR One HMD (headmounted displays). The following sections provide the recommended information to get the StarVR One Plugin setup so you can start using the cutting-edge features of the Unreal Engine for development. The Unreal Engine Plugin was designed to be extensible using StarVR Fixed Foveated Rendering.
 

Plugin UI in the Editor

To obtain a quick view of the currently installed plug-ins, open the Plugin editing interface from the UE Edit menu.
1. Launch the Epic Games interface.
2. Click on Launch Unreal Engine to open the UE interface.
3. From the tool bar select Plug-ins to view the installed plug-ins.
4. Click Installed to view the currently installed plug-ins.
The Plugin Editor is accessible from the main tool bar menu or from the main menu bar by selecting Edit > Plugins. The settings panel displays all of the available plug-ins, currently installed, that can be enabled or disabled.
The plug-ins are displayed as a list, and include the plug-in name, icon, current version, a short text description and whether or not it is enabled.
 
In the following figure, the StarVR plug-in is already installed and enabled.
 

The Structure of a Plugin

The StarVR One Plugin is designed with a Source folder. The folder contains the required directories with the module source code for the plug-in.
The plug-in also contains a Binaries folder where the compiled code for the plug-in resides. A temporary build product file is also stored under the plug-in directory in a separate intermediate folder.
A Content folder containing the Asset files specific to the StarVR One Plugin is also available within the structure. Configuration files should be placed using the same conventions as outlined:
- Engine plug-in: [ProjectRoot]/Plugins/[PluginName].ini

 

Plugin Folders

For the StarVR One Plugin to be found, it must be located in the designated search path in the project folder.

 
Plugin Search Path
StarVR One  [ProjectRoot]/Plugins/[PluginName]