Table of Contents

EasyAR Configuration

The EasyAR configuration page can be accessed from the Unity menu EasyAR > Sense > Configuration or Edit > Project Settings > EasyAR.

alt text

This contains all the global configurations for the EasyAR Sense Unity Plugin.

alt text

Initialize on startup

Initialize EasyAR when the app starts. It is generally recommended to keep this option enabled.

If disabled, you need to manually initialize EasyAR Sense. Refer to initializing EasyAR Sense for specific methods.

EasyAR Sense License

EasyAR Sense License related configurations.

LicenseKey

EasyAR Sense License Key. A valid license is required to use EasyAR features.

Can be left empty only when manually initializing EasyAR Sense via the interface.

Note

When using on head-mounted devices (Vision Pro, XREAL, Pico, Rokid, etc.), an EasyAR XR License is required.

Note

When using trial products (such as personal edition license, trial XR license, or trial Mega service, etc.) on custom cameras or headsets, EasyAR Sense will stop responding after 100 seconds (Mega users can adjust the duration after approval by EasyAR business) upon each startup. There is no such limitation when using the paid version of EasyAR Sense and the paid EasyAR Mega service.

Verify When Build

Verify the license key during Unity project build.

When this option is enabled, the Unity build process will validate the license key. If the license is invalid on the target platform or does not include the package name set in Unity Player Settings, the build process will fail. If you need to use a license key configured elsewhere or modify the package name after the Unity build process, you can disable this option.

Lib variants

EasyAR Sense library variant configurations.

EasyAR Sense License

EasyAR Sense License related configurations.

LicenseKey

EasyAR Sense License Key. A valid license is required to use EasyAR features.

Can be left empty only when manually initializing EasyAR Sense via the interface.

Note

When using on head-mounted devices (Vision Pro, XREAL, Pico, Rokid, etc.), an EasyAR XR License is required.

Note

When using trial products (such as personal edition license, trial XR license, or trial Mega service, etc.) on custom cameras or headsets, EasyAR Sense will stop responding after 100 seconds (Mega users can adjust the duration after approval by EasyAR business) upon each startup. There is no such limitation when using the paid version of EasyAR Sense and the paid EasyAR Mega service.

Verify When Build

Verify the license key during Unity project build.

When this option is enabled, the Unity build process will validate the license key. If the license is invalid on the target platform or does not include the package name set in Unity Player Settings, the build process will fail. If you need to use a license key configured elsewhere or modify the package name after the Unity build process, you can disable this option.

Permissions

App permission configuration. It is generally recommended to keep the default settings.

Except for the camera permission, other permission configurations cannot be changed and are determined by other feature configurations.

Permission Changeable Enable Condition Permission Description
Camera Yes Camera permission, required for using camera devices
AndroidMicrophone No Variant is VideoRecording Microphone permission, required for screen recording functionality
Location No Import Mega support package (fine) Location permission, required for using EasyAR Mega

Unity XR

Unity XR framework (AR Foundation, etc.) related configurations.

AR foundation support

AR Foundation support toggle, recommended to keep it on.

In rare cases, such as needing to use AR Foundation 4 or encountering compilation errors due to AR Foundation updates, you can turn this option off, but all AR Foundation-related features in the plugin will be disabled simultaneously.

Note

After modifying this option, the script will automatically recompile.

Unity XR Auto Switch

Automatically switch Unity XR (e.g., AR Foundation) object feature configurations.

  • Editor: Editor mode options
    • Disable AR Session: Disable AR Foundation's ARSession in the editor when ARSession is present.
  • Player: Runtime mode options
    • Enable: Enable runtime control. Note: If this option is turned off, components disabled in edit mode will not be restored at runtime.
    • Enable If Desktop: Enable on Windows/Mac.
    • Enable If Mobile AR On Startup: Enable if the loader for mobile AR (ARKit/ARCore) is active when the switcher starts. This option usually requires Initialize XR on Startup in XR Plug-in Management to be selected.
    • Disable If Non Mobile AR Post Startup: Disable if there are other loaders besides mobile AR (ARKit/ARCore) but none are active when the switcher starts. This option is typically used when Initialize XR on Startup in XR Plug-in Management is not selected.
    • Restore AR Session When Disabled: When the feature is disabled, restore (enable) all disabled AR Foundation ARSessions (regardless of whether they were disabled by EasyAR). This option is typically used to restore components disabled during editing.

For detailed feature descriptions, refer to Unity XR Auto Switch.

Mega

EasyAR Mega feature configuration.

Inertial camera device support

Read-only option, displays whether the inertial navigation function is available under the current configuration and ONNX runtime information.

If the displayed information does not meet the requirements, modify the Lib Variants and ONNX Runtime (Bundled) options as needed.

Mega block > Localization service access [global]

Global mega block localization server configuration.

Mega Landmark > Localization Service Access [Global]

Global Mega Landmark localization server configuration.

Spatial map

EasyAR spatial map feature configuration.

Service access [Global]

Global sparse map server configuration.

Image tracking

EasyAR image tracking feature configuration.

Target gizmo

Configuration for ImageTarget gizmos in the Unity Editor.

Enabling these options will display corresponding gizmos in the Unity Editor. If there are too many targets of this type in the scene, it may affect the startup performance in the editor. Runtime performance on devices will not be affected.

Cloud recognition (CRS) > Service access [Global]

Global cloud recognition server configuration.

Object tracking

EasyAR object tracking feature configuration.

Target gizmo

Configure the Gizmos for ObjectTarget in the editor.

  • Enable: Enable Gizmos.

Third-party libraries

Third-party library configuration.

ARCore SDK

ARCore SDK configuration.

ARCore provides motion tracking capabilities on certain Android devices. You can read Motion Tracking and EasyAR Features to understand the relationship between EasyAR features and motion tracking, and whether and when to use ARCore.

  • AR Foundation Or Optional: The ARCore SDK distributed with EasyAR or AR Foundation will be included in the app, depending on the ARCore XR Plugin settings. This option is generally recommended as it automatically handles AR Foundation scenarios.
  • Optional: ARCore features can be used on devices that support ARCore and have Google Play Services for AR installed.
  • Required: The app will only run on devices that support ARCore and have Google Play Services for AR installed.
  • External: Use this option if you are distributing ARCore SDK with AR Foundation or another ARCore SDK. This will prevent the ARCore SDK distributed with EasyAR from being used. This option can also be used to completely exclude the ARCore SDK from the app.
Caution

If you set ARCore SDK to Required, or set Requirement to Required in AR Foundation's ARCore configuration, and install the packaged app on a device that does not support ARCore, the device will incorrectly report that ARCore is available and run with ARCore. This creates a false impression that these devices are running ARCore and functioning abnormally (black screen or other anomalies), but this is incorrect.

This occurs because the Google Play Store prevents the installation of apps marked as requiring ARCore on unsupported devices, so these apps always assume they are running on supported devices.

Under normal configuration, these devices will determine that ARCore is not supported during session assembly and use EasyAR's features instead.

For detailed explanations of Optional and Required and other configurations required for publishing apps on the Google Play Store, refer to Google's documentation (Mainland China, International).

Note

In the EasyAR Sense Unity Plugin, the library files and configurations required for ARCore support are already included in the plugin package. However, to run on a mobile device, you still need to install Google Play Services for AR on the device.

There are three different sources of ARCore SDK available:

  • Using the ARCore SDK distributed with the plugin

    The plugin includes an integrated ARCore SDK version. For details, refer to ARCore, AR Engine Version Compatibility. When using EasyAR's ARCore wrapper, you do not need to import AR Foundation separately.

  • Using AR Foundation's ARCore SDK

    If you need to use AR Foundation's ARCore SDK, refer to Google's documentation (Mainland China, International) for configuration. In this case, the ARCore SDK option should be set to AR Foundation Or Optional or External.

  • Using other ARCore SDKs

    If you have other third-party plugins or projects that distribute ARCore SDK, you can also use these ARCore SDKs. In this case, the ARCore SDK option should be set to External, and you should configure it according to the specific plugin or project requirements.

Warn 32-bit-only ARCore-enabled build

According to Google's documentation, ARCore will not work properly on arm64 devices running programs with only armv7 library files. A warning will pop up during packaging if ARM64 is not selected:

alt text

In this case, you need to modify the project configuration to use IL2CPP compilation and enable ARM64 support.

alt text

Caution

If absolutely necessary, you can choose Continue and don't warn me again or disable this option, which will turn off the check during packaging. Disabling the check only suppresses the prompt during packaging, but runtime anomalies may still occur on some devices, including but not limited to crashes or black screens.

AR Engine SDK

AR Engine SDK configuration.

AR Engine provides motion tracking capabilities on some Android devices. You can read Motion tracking and EasyAR features to understand the relationship between EasyAR features and motion tracking, and whether and when to use AR Engine.

  • AREngineInterop: AREngineInterop is available. The AR Engine SDK distributed with EasyAR will be included in the application.
  • External: AREngineInterop is available. The AR Engine SDK distributed with EasyAR will not be used.
  • Disabled: AREngineInterop is not available. The AR Engine SDK distributed with EasyAR will not be used. All features related to AR Engine will be disabled.

Onnx runtime (bundled)

Whether to use the bundled ONNX runtime. Only valid when Lib Variant is Full.

To use a different version of ONNX, you can obtain an updated version from the official ONNX and disable this option. Using self-compiled binaries with incompatible ONNX versions may cause unknown errors.

Workaround for Unity

Workarounds for Unity bugs or unreasonable behaviors.

GenerateXMLDoc

Generate XML documentation when the script is reloaded to enable intelliSense for API documentation.

URP17RG_DX11_RuinedScene

Workaround for URP 17 Render Graph DX11 scene rendering corruption. This option is disabled in Unity 6.2 and later versions.

URP17RG_IOS_Glitches_Partial

Partial workaround for Unity Issue UUM-87787.

Brief description of the issue: When obtaining camera textures from EasyAR (similar to the usage in the ImageTracking_Coloring3D sample and the ARSession workflow (CameraDevice) example), visual glitches and artifacts can be observed on iOS/Mac devices. We have reproduced this issue in a pure Unity package and reported it to Unity: Glitches on iOS with AR Camera Image Rendering (URP 17 render graph). For updates on the issue, follow Unity Issue UUM-87787 and future Unity release notes.