Try MAXST AR Fusion Tracker Now ✨

Setup Guide

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


Set Up Unity Development Environment

Requirements

  • We recommend Unity 5.6.2, 2017 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.


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 5.0, please add the following build settings.

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

Remove Vulkan

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

Minimum API Level

Set Minify to None in the Publishing Settings.

Setting Minify

Check ARCore Supported in XR Settings.

ARCore Supported


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


Build a Sample App (iOS)

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.

    setUpAddSceneiOS

  4. Place Home Scene at the top.

    setUpHomeSceneiOS

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

    setUpSwitchPlatformiOS

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

    setUpPlayerSetiOS

  7. In the Inspector window, enter ‘8.3' in Target minimum iOS Version and ‘description' in Camera Usage Description .

    setUpiOS

  8. In the Inspector window, enter Bundle Identifier.

    setUpOtherSetiOS

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

※ Fusion Tracker works on iOS Version 11 or later.

  1. Select 'File > Build'

  2. Run the generated Xcode project file.

    setUpiOSBuild

  3. Connect a test phone / configure the Signing and build.

    setUpiOSSign


Issue Sample App (iOS)

Issue 1 :

Undefined symbols for architecture armv7: "_maxst_TrackedImage_getYuv420_888YUVPtr", referenced from:

Reason:

An error about framework and library linking occurs in XCode

Checklist:

1-1. Have you set the Architectures of “Build Settings/Architectures” to arm64?

  • Please note that from iOS 11, only 64-bit apps work.

Answer1.png

1-2. Did you build by selecting the iOS device?

answer2.PNG

1-3. Did you properly add ARKit.framework, Accelerate.framework and libMaxstAR.a files to “Targets/UnityFramework/General/Frameworks and Libraries” before proceeding with the build in XCode?

  • After exporting Unity-iOS project to XCode go to add framework and library.
  • Set the Platforms of ARKit.framework, Accelerate.framework and libMaxstAR.a file to macOS + iOS.

Answer3.png

1-4. Have you properly added ARKit.framework, Accelerate.framework and libMaxstAR.a files to “Targets/UnityFramework/Build Phases/Link Binary With Libraries” before proceeding with the build in XCode?

  • Set the Platforms of ARKit.framework, Accelerate.framework and libMaxstAR.a files to macOS + iOS.

Answer04.png

1-5. Did you set Enable Bitcode to No in “Build Settings/Build Options”?

Answer05.png


GitHub Unity Scene Example

GitHub Unity Scene Example:

MaxstARSDK_Unity_Sample.git or More

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