Quickstart in Unity

Set up your Unity Project

Get your Developer Token

Register yourself at ARWAY Developer Portal. Get your unique developer token from the API section.


Our REST API requires a developer token for authentication. You can get it by logging in to the Developer Portal with your registered email and password.
// Example Token
Get your unique Developer Token to make REST APIs calls. It is used in the header to make an API call to our servers.

Download the ARWAY SDK

There are 2 ways to download the ARWAY SDK -

Method 1: Using the UNITY_SDK Project

Step 1: Download the UNITY_SDK project from the Developer Portal Downloads section.
Download the latest SDK or Mapping app
Step 2: Extract the .zip file and add the project into Unity Hub.
Screenshot of Unity Hub
Step 3: Open the project with Unity 2019.4.3f1 or above till 2020.2 (2020.3 and above not supported).

Method 2: Importing the Unity Package

Step 1: Download the latest '.unitypackage' from the Releases page on GitHub.
ARWAY SDK Unity Package
Step 2: Import the '.unitypackage' into your Unity project.

Configure the Project Settings

Step 1: Open the Package Manager (Window -> Package Manager) and install the following components if not already installed -
  • AR Foundation >= 4.1.1 (2019.4 verified)
  • ARCore XR Plugin >= 4.1.1 (2019.4 verified)
  • ARKit XR Plugin >=4.1.1 (2019.4 verified)
  • XR Plugins management >= 3.2.16 (2019.4 verified)
  • TextMesh Pro >= 2.1.1 (2019.4 verified)
Step 2: Go to Player Settings (Edit -> Project Settings -> Player -> Other Settings)
  • Turn OFF the Auto Graphics API.
  • For iOS:
    • Set Graphics API to Metal.
    • Set Target Minimum Version to 12.0.
  • For Android:
    • Set Graphics API to OpenGLES3.
    • Set Minimum API Level to 24 (Android 7.0).
    • Disable Multithreaded Rendering
  • Turn ON Allow 'unsafe' Code.
Step 3: Setup your AR Settings for the platforms you are building for in the XR Plug-in Management (Edit -> Project Settings -> XR Plug-in Management)
Setup AR Settings in XR Plug-in Management
Step 4: Import the '*.tgz' Azure Spatial Anchors packages located in the Assets\ARWAYSDK\Azure Spatial SDK\Packages\ folder using the Unity Package Manager.
Import tarball packages

Configure the mainTemplate.gradle file (Android only)

Step 1: Go to Edit > Project Settings > Player.
Step 2: In the Inspector Panel for Player Settings, select the Android icon.
Step 3: Under the Build section, check the Custom Main Gradle Template checkbox to generate a custom Gradle template at Assets\Plugins\Android\mainTemplate.gradle.
Step 4: Open your mainTemplate.gradle file in a text editor.
Step 5: In the dependencies section, paste the following dependencies:
Step 6: When it's all done, your dependencies section should look something like this:
dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])