Skip to content

Getting Started

Welcome! This SDK allows you to integrate your Unity projects with Cognitive3D, which provides analytics and insights about your participant's behavior in VR and AR.

Setup

Download the latest SDK package from GitHub and import the package into your project.

The Scene Setup Window should automatically open or it can be opened from the Cognitive3D menu on the Unity Toolbar. This window will guide you through some basic Terminology and setup. When you select the VR SDK you are using, several features will be automatically enabled, such as Eye Tracking for supported HMDs.

Settings Window

You will need your Developer Key and Application Key from the Cognitive3D Dashboard to complete this Scene Setup Window. You may need to press Generate Developer Key and Generate Application Key.

Dashboard API Key

If you have any objects in your scene that move (other than the player), add a Dynamic Object Component to that object. Dynamic Objects are covered in more detail in Comprehensive Setup Guide and Dynamic Objects.

The Scene Setup Window will ask you to export and upload your scene to our Dashboard. This may take some time depending on your internet connection, and size of the scene.

The Scene Setup Window will automatically add a CognitiveVR Manager to the scene. This manager will automatically send a "Session Begin" Custom Event, Gaze and basic information about the device. This manager also persists upon changing scenes.

Simply press "Play" in the Unity Editor and you will see a new session on the Dashboard.

Next Steps

Once you verify that your data is being recorded properly, there are several ways to record more data to allow for deeper insights into your experience. The Comprehensive Setup Guide goes into an overview of how to set up each of the SDK's core features.