Getting Started

Register

Register for a free account in the Developer Portal https://developers.immersal.com/
The free license has capacity limitations, but you can use it even for commercial projects and it suits many use cases.

Download the Mapper

Our Immersal Mapper App is available for download for both Android and iOS.
You can use the app with your free account.
‎Immersal Mapper
App Store
Immersal Mapper - Apps on Google Play
GooglePlay

Authentication

Immersal Cloud Service REST API requires a developer token for authentication.
You can get it from the Developer Portal
Spatial Mapping can be done with Immersal Mapper App without knowing the token, simply by logging in with your credentials.
In your apps, Visual Positioning (localization) can also be done without the Immersal Cloud Service and the required token.
You can embed your Spatial Maps into your app and use on-device Visual Positioning completely offline.
1
// example token
2
ad9c8853ecda657cc94f71a2b8fbc4524a2a032d8de85f05f6d9a4646bb39249
Copied!

Quick Start with Unity

Setup
Download the latest Immersal SDK Core .unitypackagefrom the Developer Portal and the latest immersal-sdk-samples sample project from Immersal's GitHub repository
The sample project is already configured and has all required packages and settings in place.
  • Open the sample project in Unity 2020.3.20f1
    • There will be some errors when opening the sample project without the Immersal SDK Core, do not enter Safe Mode when prompted
  • Import the latest Immersal SDK Core .unitypackage into the sample project
    • Assets -> Import Package -> Custom Package -> ImmersalSDKv1_15_0.unitypackage
    • Errors should now have been cleared
  • The packages and settings are already configured. In case you're having problems
    • Use the Unity Package Manager (Window -> Package Manager) to check that the following packages are installed
      • AR Foundation 4.1.7
      • ARCore XR Plugin 4.1.7
      • ARKit XR Plugin 4.1.7
      • Editor Coroutines 1.0.0
      • OpenXR Plugin 1.2.8
      • TextMesh Pro 3.0.6.
      • Multiplayer HLAPI 1.0.8.
      • Unity UI 1.0.0
      • Universal RP 10.6.0
  • Go to Edit -> Project Settings -> Player -> Other Settings to check the following settings
    • Auto Graphics API should be turned Off
    • For Windows
      • Set Graphics API to OpenGLCore
    • 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
Building your first app
Start by building the Mapping App sample scene for your device and reading the How To Map documentation.
Part 0 - Getting Started and Building the Mapper
Vimeo
Note, you don't have to build the Mapper. It's available in the App Stores as mentioned above.

Tutorial Series

We have a Getting Started-series for our Unity plugin. https://vimeo.com/showcase/6343595
Last modified 1mo ago