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.26.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

Note

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

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

Close the Unreal Editor (if it is open) and 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.

Step 4: Open the Scene Setup Window

Open the Cognitive Scene Setup window from the Windows menu. In Unreal 5.0 and newer, the Cognitive Scene Setup window is available from the Tools 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.

When this process is complete, you should notice a new CognitiveVR Actor in your level. This Actor is configured to automatically start collecting basic data.

Done!

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