Using the Cognitive3D SDK for Unreal

Welcome! This SDK for Unreal provides analytics and insights about your project. In addition, Cognitive3D empowers you to take actions that will improve users' engagement with your experience.

This SDK is in development and changes should be expected! Please get in touch if you experience any issues.

This plugin has been tested with Unreal verion 4.14.3. If you are using a newer version, please check Troubleshooting. It has only been tested on Windows 10.


Step 1: Sign up

If you have not already done so, please book a demo at cognitive3d.com.

Step 2: Download the SDK

Our package is available on our Github Release page.

Step 3: Import the SDK

These instructions will help you install the C++ API as well as Blueprint nodes

Note

Your Unreal project must be a C++ project to use plugins. To convert from a Blueprint project, see Troubleshooting first

  • Close Unreal
  • Copy the plugins folder into your project root. This is the directory with Binaries, Intermediate and Source folders and YourProjectName.uproject file

root

  • Open Source/YourProjectName/YourProjectName.Build.cs. Add the following line:

    PublicDependencyModuleNames.AddRange(new string[] {"CognitiveVR", "Json", "JsonUtilities"});
    

  • Delete the Binary folder in your project. This is regenerated when you recompile

  • Add the following Plugins section to YourProjectName.uproject to enable Analytics Blueprints if they are not yet enabled. You will need to open YourProjectName.uproject with a text editor. This is an example of a completed .uproject file:
{
    "FileVersion": 3,
    "EngineAssociation": "4.14",
    "Category": "",
    "Description": "",
    "Modules": [
        {
            "Name": "YourProjectName",
            "Type": "Runtime",
            "LoadingPhase": "Default"
        }
    ],
    "Plugins": [
        {
            "Name": "AnalyticsBlueprintLibrary",
            "Enabled": true
        }
    ]
}
  • Right-click on YourProjectName.uproject and select Generate Visual Studio project files
  • When you open your project through the Epic Games Launcher, you will be prompted to recompile your project and the cognitiveVR Plugin

  • If the plugin is loaded correctly, it should be visible in the Plugins window

Plugins Window

Step 4: Open the Scene Setup Window

Click Window->Cognitive Scene Setup

scene setup menu

Follow the instructions. You will need to have your Developer Key and API Key from the Dashboard. You will also need to have Blender installed. Blender is free and open source - we use this to automatically convert images exported from Unreal Engine.

scene setup

Add a Player Tracker component to your Player Actor and add a Start Session node to your level blueprint

simple bp start

Done!

That's it! You are now tracking your user's basic data including engine version, CPU brand, RAM, GPU, HMD and OS