Setup Guide

Set Up Unity Development Environment
Install MAXST AR SDK for Unity
Run Sample App (Unity Editor)
Build Sample App (Android)
GitHub Unity Scene Example


Set Up Unity Development Environment

Requirements

  • We recommend Unity 2018 or later to use MAXST AR SDK in Unity.

  • For more information on Unity development tools, visit Unity Website.

※ To use MAXST AR SDK for Unity, you need basic knowledge of Unity development tools and Unity development.


Install MAXST AR SDK for Unity

  1. Download MAXST AR SDK.

  2. Open the Unity project or create a new one.

  3. Import MAXST AR SDK for Unity by double-clicking the downloaded MAXST AR SDK Package or by selecting 'Assets / Import Package / Custom Package' from the Unity Editor menu and selecting the downloaded Package.

  4. For MacOS, download the Unity for MacOS Plugin, unzip it, and copy the MaxstAR.bundle file to Assets/Plugins.

  • Since 2021.1 and earlier versions do not support Notarization on MacOS, you will need to run the following command to de-secure it.

    cd Assets/MaxstAR/Plugins

    xattr -cr MaxstAR.bundle

    sudo spctl —master-disable


Run Sample App (Unity Editor)

To run the MAXST AR SDK sample app for Unity, follow these steps.

  1. Install MAXST AR SDK for Unity.

  2. In Unity Editor, select 'File > Build Settings'

  3. In the Project View, add scenes from the 'Assets > MaxsARSamples > Scenes' folder to 'Build Settings > Scenes In Build'

    setUpAddScene

  4. In Project View, double-click the Home scene in the Assets > MaxsARSamples > Scenes folder.

  5. Press the Play button on the Toolbar.

    setUpToolBar


※ Moving from the Target scene to the Home scene by pressing the esc key.


Build a Sample App (Android)

To build the MAXST AR SDK sample app for Unity, follow these steps.

  1. Install MAXST AR SDK for Unity.

  2. In Unity Editor, select 'File > Build Settings'.

  3. In the Project View, add scenes from the 'Assets > MaxsARSamples > Scenes' folder.

    setUpAddScene

  4. Place Home Scene at the top.

    setUpHomeScene

  5. In the Platform window, select Android and click the Switch Platform button.

    setUpSwitchPlatform

  6. In the Platform window, click the Player Settings button.

    setUpPlayerSet

  7. In the Inspector window, enter Package Name.

    setUpOtherSet

  8. Enter the license key. To get the license key, please refer to License Manager.

  9. After connecting the device, select 'File > Build&Run'

    ※ If the Android SDK is not properly configured, the file selection window of the message(Select Android SDK root folder) may appear. You can do this by choosing Edit> Preferences from the Unity Editor menu bar.

    setUpPref

  10. To use Fusion Tracker series added in MAXST AR SDK, please add the following build settings.

  • If Auto Grapchis API is checked in Other Settings, uncheck it

  • If you have Vulkan in the Graphics APIs in Other Settings, delete it.

  • If Multithreaded Rendering is selected in Other Settings, uncheck it.

    RemoveVulkan

  • Set the Minimum API Level to API level 26 or higher in Other Settings.

    Minimum API Level

  • Set Minify to None in the Publishing Settings.

    Setting Minify


Android Split APK(OBB)

Split APK is used to upload apk file to PlayStore. PlayStore can not upload more than 100Mb apk, so we will upload apk and obb files separately.

  1. File -> Build Settings -> Android ->Player Settings -> Publish Settings -> Split Application Binary.

Android 64-bit build settings

Starting with the MAXST AR SDK version 4.1.1, Unity-Android 64-bit builds are supported. To use a 64-bit build, follow these steps to build your build:

  1. Click the File menu> build settings> Player settings button

  2. In the Inspector window, select the Other Settings > Scripting Backend drop-down menu> Change to IL2CPP

  3. ARM64 check

  4. Click libMaxstAR.a under Plugins folder> Android folder> libs folder> arm64-v8a folder> Confirm Android check and change CPU drop-down menu to ARM64


GitHub Unity Scene Example

GitHub Unity Scene Example:

MaxstARSDK_Unity_Sample.git or More

  • ExtraImageTrackerKnight
  • ExtraImageTrackerMultiTarget
  • ExtraInstantTrackerBrush
  • ExtraInstantTrackerGrid
  • ExtraInstantTrackerMultiContents
  • ExtraVisualSLAMBrush
  • ExtraVisualSLAMKnight