Immerse SDK
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

Project Setup

Once the SDK plugin has been added and enabled in the project, the next step is to sign in via the Immerse SDK editor window. This will need to be done each time you launch the Unreal Editor.

The Immerse SDK window can be opened via the Unreal Editor menu Window > Immerse SDK

Signing in requires an Immerse developer account. All SDK features will be unavailable until you are signed in.

Immerse SDK sign in page

Immerse SDK sign in page

Project Management

A project stores metadata for your application and provides access to reports.

Creating a Project

If you do not already have a project, you will need to create one from the developer portal. Once you have signed in via the Immerse SDK window in Unreal, you will be presented with a page displaying an ‘Open Developer Portal’ button. Clicking this button will open the developer portal in your default browser.

From the developer portal:

  1. Click the ‘Create Project’ button
  2. Select ‘Unreal Engine’ and click Create
  3. You will now be taken to the project page. You may rename your project here

Linking a Project

Once you have created a project on the developer portal, you then need to link it to your project in the Unreal Editor.

  1. Click ‘Copy project ID’ at the top of the developer portal project page screen
  2. Paste the project ID into the field in the Immerse SDK window in Unreal
  3. Click ‘Link Project

The SDK will now validate that the project ID was entered correctly and send an update to the platform. You have successfully linked your project!