Skip to content

Using the Cognitive3D SDK for Unreal

Welcome! This SDK for Unreal integrates your project with Cognitive3D, which provides analytics and insights about your participant's behavior in VR and AR. In addition, Cognitive3D empowers you to take actions that will improve participants' 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 requires Unreal verion 4.19.2 or newer. If you are using a newer version, please check Troubleshooting.


Step 1: Sign up

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

Step 2: Download the SDK

Our plugin is available on our Github Release page.

Step 3: Import the SDK

Extract the plugin into your project directory. Rename the plugin folder to "Plugins".

root

Note

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

Ensure that the Analytics Blueprints Plugin is enabled. You can either enable it in the Plugins browser in the Unreal Editor or by modifying the uproject file.

Complete .uproject file

{
    "FileVersion": 3,
    "EngineAssociation": "4.19",
    "Category": "",
    "Description": "",
    "Modules": [
        {
            "Name": "YourProjectName",
            "Type": "Runtime",
            "LoadingPhase": "Default"
        }
    ],
    "Plugins": [
        {
            "Name": "AnalyticsBlueprintLibrary",
            "Enabled": true
        }
    ]
}

Close the Unreal Editor and re-open it through the Epic Games Launcher. You should 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

Open the Cognitive Scene Setup Window from the Windows menu.

scene setup menu

Follow the instructions in the Scene Setup Window to upload your Level to the Dashboard. You will need to have your Developer Key and Application 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.

simple player actor

Add a Start Session node to your level blueprint.

simple bp start

Done!

Press "Play" in the Editor and you will see a new session on the Dashboard. See Feature Overview for the next steps.