Getting Started

Register

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

Download the Mapper

Our Mapping App is available for download for both Android and iOS

You can use the app with your registered account.

Authentication

Our REST API requires a 256-bit token for authentication. You can get it by logging into the Developer Portal with your email and password.

// example token
84232462346234623ajefl62454766a616b2fegbd7754a73386d785985226577613349741326473972754e4c33526b5a334298712e414544

You need a token to use our REST API which is required by many of the samples. Visual positioning (localization) can be done on-device without a token.

The mapper does not need the token.

Quick Start with Unity

Download the latest SDK from the Developer Portal and the latest sample project from our GitHub repository.

  • Open the sample project first. There will be some errors when first opened without the SDK.

  • Import (Assets -> Import Package -> Custom Package...) the latest SDK (ImmersalARCloudSDKvXX.unitypackage) into the sample project.

  • If needed, use the Package Manager (Window -> Package Manager) to install

    • AR Foundation 3.0.0

    • ARCore XR Plugin 3.0.0

    • ARKit XR Plugin 3.0.0

    • TextMesh Pro (2.0.1 is verified to work).

    • Multiplayer HLAPI 1.0.4.

  • 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 Mapping App sample scene for your device and reading the How To Map-instructions.

Tutorial Series

We have a Getting Started-series for our Unity plugin. https://vimeo.com/showcase/6343595