Building from the Source Code

Building the sample app provided in the ARwayKit SDK

To build the sample app directly from the source code (.zip) provided in the release, follow the below steps.

Get the ARwayKit SDK Source Code

Download the .zip from our GitHub. Please contact us for access.

Prerequisites

In this guide, we will be using the following versions of Unity:

• Unity: 2022.3.62f3

  • Include the following platforms in your Unity install:

    • Android Build Support

      • OpenJDK

      • Android SDK & NDK Tools

    • iOS Build Support

Implementation

In the instructions below, we will be using the provided .zip source code to create a new app. If you already have an existing Unity app to which you wish to add the package, please refer to the instructions provided in the link below.

Integrating the Unity Package

Getting the Account ID and Secret Key

1. From the ARway Creator Portal, go to "For Developers -> Create a New App -> Enter App Name".

2. Copy your Account ID and SecretKey for that App.

The "For Developers" page of the Creator Portal

Opening the Project in Unity

1. Download the .zip file source code for the latest release.

2. Extract the .zip file to a new folder.

3. Open Unity Hub, and click "Add" > "Add project from disk" and select the extracted zip file.

4. Open the project using Unity Editor Version 2022.3.62f3.

Adding the Account ID and Secret Key

1. In the Project Window, go to "Assets -> ARway -> Viewer Mode -> Resource-> ARWayKitConfig
" and add your credentials for the Account ID and Secret Key.

AR Way Kit Config

Switch Build Platform to Android or iOS.

1. "File -> Build Settings -> Build -> Select iOS/Android"

Updating the Addressables Groups

1. Navigate to "Window -> Asset Management -> Addressable -> Groups".

2. In the Addressables Groups window, click on "Build -> New Build -> Default Build Script".

When making any changes that affect localization strings, you will need to update the Addressables Groups.

Android Build Signing

When building for Android, Unity requires a keystore to sign the application.

1. Go to Project Settings > Player > Android > Publishing Settings.

2. Under Custom Keystore, you have two options:

   • Use your own keystore: If you have a production key (recommended for release builds), set the path to your .keystore file and provide the alias, password, and key details.

   • Use the debug key for testing: If you don’t need a custom key (e.g., for local development or quick testing), uncheck Custom Keystore. Unity will then sign the app automatically with the default debug keystore.

Important:

• A debug key is fine for testing, but Google Play requires your app to be signed with your own keystore. Make sure to generate and securely store a keystore for release builds.

Building the App

1. In Unity select "File -> Build Settings".

2. Ensure the following scenes are selected in the following order:

   • ARWay/ViewerMode/0_Scene/Dashboard-SDK

   • ARWay/ViewerMode/0_Scene/ARMapSession

   

   Build Settings Window
3. Change the platform to either Android or iOS by selecting "Android or iOS -> Switch Platform".

4. Select "Build and Run" to run the app.

   1. If you see a pop-up for "Unsupported Input Handling" click "Yes"

After successfully building the app on your device, you can scan QR codes that you created for your ARway maps in the Creator Portal.

Dashboard scene