Overview: This is an Unreal Engine plugin which implements the Apex API, supporting Unreal Engine 4.26.0 to 4.27.2. Communication to the Apex Server uses REST https JSON requests which follow the xAPI Standard.

Adding the Unreal Apex SDK to your Unreal Project

Your Unreal project must be a C++ project in order for this plugin to compile and work. If your project is Blueprint Only, please convert it to a C++ Project.

To add the Unreal Apex SDK, follow these steps:

1. Download the Unreal Apex SDK zip file.
2. In your Unreal project folder, add a Plugins folder if one does not already exist.
   1. In the Plugins folder, copy the Unreal Apex SDK zip file.
   2. Unzip the Unreal Apex SDK into a folder called UnrealApexSDK.
3. Back in the project folder, right-click on your .uproject file and Generate Visual Studio project files.
4. Launch into the editor and follow the steps below to configure your project settings.

Configuring the Apex SDK

After installing the Unreal Apex SDK, open the Unreal Engine editor. Open your project's Project Settings, scroll down to Plugins and select the Apex SDK settings category.

Important ApexSystem Properties

The following properties will need to be set in these settings:

• ServerIP: This is the server IP address that you want to send the information to. By default it will point to our production environment.

  • Use https://modules.apex.pixovr.com/

• ModuleID: The ID of the module that will be distributed to customers. This will be generated when you create a project on the Platform. This must be set for the data to be reported to the proper module.

• ModuleVersion: The version number of your module currently on the Platform. Please update the version number every time you prepare a new build for the Platform.

  • The Module Version is based on Semantic numbering with a Major, Minor and Patch number.

  • Both Minor and Patch numbers are always 2 digits, using a 0 as the first value when the number is below 10. (e.g.) 1.03.08. This is enforced on the Platform itself as well. 

Optional settings that can help with synchronizing information across the project:

• Sync Module Version: This checkbox, when ticked, will change the Unreal Project's version number to match the Module Version.
• Additional Synchronized Version Fields: These settings only take affects if Sync Module Version is ticked.
  • Android Store Version: This will change the "Store Version" and "Version Display Name" found under the Platform - Android settings.
  • PixoVR Plugin Version
    • This will change "The Version of the Module" setting found under the Plugins - PixoVR settings.
    • This plugin is for internal use only.

Understanding xAPI

Data sent to the PIXO Platform is formatted using the xAPI Standard. The Unreal SDK utilizes a custom implementation of the xAPI standard.

More Info: To get a better understanding of the xAPI Standard, visit the xAPI Spec here

Next Article: Authentication or Understanding xAPI Articles