Getting Started

Register

Register for a free trial account at https://immersal.com/developers/.

Authentication

The SDK uses a developer token to access the REST API required to map spaces to enable AR experiences. You can get it by logging into our Developer Portal with your registered email and password. The latest version of the SDK can also be downloaded from the portal.

// example token
84232462346234623ajefl62454766a616b2fegbd7754a73386d785985226577613349741326473972754e4c33526b5a334298712e414544

You need a Developer Token to map a space, but visual positioning (localization) can be done without one.

Quick Start with Unity

Download the SDK from our Developer Portal and Sample Project from our GitHub repository.

  • Open the Sample project.

  • Import (Assets -> Import Package -> Custom Package...) the ImmersalARCloudSDKvXX.unitypackage into your chosen Unity project.

  • If needed, use the Package Manager (Window -> Package Manager) to install AR Foundation 1.5.0, ARCore XR Plugin 2.1.0, ARKit XR Plugin 2.1.0 and also TextMesh Pro (1.4.7 is verified to work).

  • Go to Edit -> Project Settings -> Player -> Other Settings

    • Turn off the Auto Graphics API.

    • For Windows:

      • Set primary API to OpenGLES3

    • For iOS:

      • Set Graphics API to Metal.

      • Set Target Minimum Version to 11.3.

    • For Android:

      • Set Graphics API to OpenGLES3.

      • Set Minimum API Level to 26.

Start by building the provided Mapping App sample scene for your device and then reading the How To Map-instructions.