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 page contains all the global configurations for the EasyAR Sense Unity Plugin.

alt text

Initialize On Startup

Initialize EasyAR on startup. It is generally recommended to keep this option enabled.

If this option is disabled, you need to manually initialize EasyAR Sense. For specific methods, refer to Initializing EasyAR Sense.

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 display 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) on custom cameras or headsets, EasyAR Sense will stop responding 100 seconds after each startup (the duration can be adjusted via EasyAR Business upon approval for Mega users). Using the paid version of EasyAR Sense and the paid EasyAR Mega service does not have this restriction.

Verify When Build

Verify the license Key during the Unity project build process.

When this option is enabled, the Unity project build process will verify the license Key. If the license is invalid on the build 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 need to modify the package name after the Unity build process, you can disable this option.

Lib Variants

Configuration for EasyAR Sense library variants.

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 display 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) on custom cameras or headsets, EasyAR Sense will stop responding 100 seconds after each startup (the duration can be adjusted via EasyAR Business upon approval for Mega users). Using the paid version of EasyAR Sense and the paid EasyAR Mega service does not have this restriction.

Verify When Build

Verify the license Key during the Unity project build process.

When this option is enabled, the Unity project build process will verify the license Key. If the license is invalid on the build 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 need to modify the package name after the Unity build process, you can disable this option.

Permissions

Configuration for application permissions. 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 Can be changed Enable condition Permission description
Camera Yes Camera permission, required to use the camera device
AndroidMicrophone No Variant is VideoRecording Microphone permission, required to use the screen recording function
Location No Import the Mega support package (Fine) Location permission, required to use EasyAR Mega

Unity XR

Configuration related to the Unity XR framework (such as AR Foundation).

AR Foundation Support

Switch for AR Foundation support. It is recommended to keep it enabled.

In rare cases, such as when you need to use AR Foundation 4 or encounter compilation errors due to AR Foundation updates, you can disable this option. However, all AR Foundation-related functions in the plugin will be disabled at the same time.

Note

After modifying this option, the scripts will be automatically recompiled.

Unity XR Auto Switch

Configuration for the function of automatically switching Unity XR (such as AR Foundation) objects.

  • Editor: Options for the editing mode
    • Disable AR Session: When ARSession exists, disable the ARSession of AR Foundation during editing.
  • Player: Options for the running mode
    • Enable: Enable runtime control. Note: If this option is disabled, the components disabled in the editing mode will not be restored during runtime.
    • Enable If Desktop: Enable on Windows/Mac.
    • Enable If Mobile AR On Startup: When the switcher starts, if the loader of mobile AR (ARKit/ARCore) is active, enable it. Usually, the Initialize XR on Startup option in XR Plug-in Management needs to be selected.
    • Disable If Non Mobile AR Post Startup: When the switcher starts, if there are other loaders besides mobile AR (ARKit/ARCore) but none of them is active, disable it. Usually, this option is used when the Initialize XR on Startup option in XR Plug-in Management is not selected.
    • Restore AR Session When Disabled: When the function is disabled, restore (enable) all disabled ARSessions of AR Foundation (regardless of whether they were disabled by EasyAR). This option is usually used to restore the components disabled during editing.

For detailed function descriptions, refer to Unity XR Automatic Switching.

Mega

Configuration for the EasyAR Mega function.

Mega Block/Landmark Support

Whether to enable Mega Block/Landmark support.

This option will be enabled by default after importing com.easyar.mega and disabled by default if not imported.

InertialCameraDevice Support

A read-only option that shows whether the inertial navigation function is available under the current configuration.

If the displayed information does not meet your requirements, you need to modify the Lib Variants option as appropriate.

ONNX Support

A read-only option that shows information about the ONNX runtime under the current configuration.

If the displayed information does not meet your requirements, you need to modify the Lib Variants and ONNX Runtime (Bundled) options as appropriate.

Mega Block > Localization Service Access [Global]

Configuration for the global Mega Block localization server.

Mega Landmark > Localization Service Access [Global]

Configuration for the global Mega Landmark localization server.

Spatial Map

Configuration for the EasyAR spatial map function.

Service Access [Global]

Configuration for the global sparse map server.

Image Tracking

Configuration for the EasyAR image tracking function.

Target Gizmo

Configuration for the Gizmos of ImageTarget in the editor.

Enabling these options will display the 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. The performance when running on the device will not be affected.

Cloud Recognition (CRS) > Service Access [Global]

Configuration for the global cloud recognition server.

Object Tracking

Configuration for the EasyAR object tracking function.

Target Gizmo

Configuration for the Gizmos of ObjectTarget in the editor.

  • Enable: Enable the Gizmos.

Third-Party Libraries

Third-party library configuration.

ARCore SDK configuration

ARCore SDK configuration.

ARCore provides motion tracking capabilities on some Android devices. 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 application, determined by ARCore XR Plugin settings. This option is generally recommended as it automatically handles AR Foundation scenarios.
  • Optional: ARCore features can be used on devices supporting ARCore with Google Play Services for AR installed.
  • Required: The application will only run on devices supporting ARCore with Google Play Services for AR installed.
  • External: Use this option if distributing ARCore SDK via AR Foundation or other sources. The ARCore SDK distributed with EasyAR will not be used. This option can also exclude ARCore SDK entirely from the application.
Caution

If ARCore SDK is set to Required, or if Requirement is set to Required in AR Foundation's ARCore configuration, and the packaged application is installed on a device that does not support ARCore, the device will incorrectly report ARCore as available and run with ARCore. This creates a false impression that these devices are running ARCore but malfunctioning (black screen or other abnormalities), which is incorrect.

This occurs because Google Play Store prevents installing apps marked as requiring ARCore on unsupported devices, so such apps always assume they run on supported devices.

Under normal configuration, these devices will detect ARCore as unsupported during session assembly and use EasyAR features instead.

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

Note

In EasyAR Sense Unity Plugin, the library files and configurations required for ARCore support are included in the plugin package. However, to run on mobile phones, Google Play Services for AR must be installed on the device.

Three sources of ARCore SDK are available:

  • Using the ARCore SDK distributed with the plugin

    The plugin integrates an ARCore SDK version. For details, refer to ARCore, AR Engine Version Compatibility. When using EasyAR's ARCore wrapper, importing AR Foundation separately is optional.

  • Using AR Foundation's ARCore SDK

    If using AR Foundation's ARCore SDK, configure it according to Google's instructions (Mainland China, International). In this case, the ARCore SDK option must be set to AR Foundation Or Optional or External.

  • Using other ARCore SDKs

    If other third-party plugins or projects distribute ARCore SDK, these can also be used. Set the ARCore SDK option to External and configure according to the specific plugin or project requirements.

Warn 32-bit-only ARCore-enabled build

According to Google, ARCore will not function properly on arm64 devices running applications with only armv7 library files. A warning will appear during packaging if ARM64 is not selected:

alt text

Modify project configuration to use IL2CPP compilation and enable ARM64 support.

alt text

Caution

If absolutely necessary, select Continue and don't warn me again or disable this option to skip the check during packaging. Disabling the check only suppresses the packaging prompt but may cause runtime exceptions on some devices, including crashes or black screens.

AR Engine SDK configuration

AR Engine SDK configuration.

AR Engine provides motion tracking capabilities on some Android devices. 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 available. The AR Engine SDK distributed with EasyAR will be included in the application.
  • External: AREngineInterop available. The AR Engine SDK distributed with EasyAR will not be used.
  • Disabled: AREngineInterop unavailable. The AR Engine SDK distributed with EasyAR will not be used. All AR Engine-related features will be disabled.

ONNX Runtime (Bundled)

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

To use a different ONNX version, obtain an updated version from the official ONNX source and disable this option. Using self-compiled binary-incompatible ONNX may cause unknown errors.

Workaround For Unity

Solutions to deal with Unity bugs or unreasonable behaviors.

GenerateXMLDoc

Generates XML documentation during script reload to enable API doc intelliSense.

URP17RG_DX11_RuinedScene

Workaround for URP 17 Render Graph DX11 scene rendering corruption. Disabled in Unity 6.2+.

URP17RG_IOS_Glitches_Partial

Partial workaround for Unity Issue UUM-87787.

Issue summary: When obtaining camera textures from EasyAR (as used in examples like ImageTracking_Coloring3D and ARSession workflow (CameraDevice)), visual glitches and artifacts are 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). Track progress via Unity Issue UUM-87787 and future Unity release notes.