Table of Contents

Using AllSamplesLauncher to quickly experience EasyAR samples

AllSamplesLauncher is an integrated sample launcher that helps you quickly familiarize yourself with various features of the EasyAR SDK. Through this launcher, you can switch and run all official sample scenes with one click in a single Unity project without manually configuring multiple independent projects.

Preparations

Before starting, please ensure you have completed the following preparations:

  1. Installed Unity Hub and Unity Editor
  2. Created a new Unity project
  3. Imported the EasyAR Sense Unity Plugin and imported all Samples

Please refer to the instructions in Quick Start to proceed step by step.

Detailed steps

  1. Open all scenes in Samples.
    All Sample Scenes
  2. Click the menu bar File > Build Settings or Build Profiles > Scene List.
  3. Drag all scenes into Scene List.
  4. Ensure AllSamplesLauncher is the first in all scenes. If not, drag it within the window.
    Scene List Order
  5. Click the menu bar File > Build And Run to package and run.
Note

When packaging to run on mobile phones, do not add headset-related scenes:

  • Combination_BasedOn_AppleVisionPro
  • Combination_BasedOn_Xreal
    Donot Load Headset

Issues encountered during packaging

During compilation and packaging, you may encounter some errors. Common issues include:

Error Message Cause Solution
FileNotFoundException:EasyAR Settings Asset License not filled Click the menu bar EasyAR > Sense > Configuration, and fill in your License Key in EasyAR Sense License
Missing Prefab Asset: 'XR Interaction Setup' Headset-related files missing Remove headset-related scenes from the packaging scene list. If you confirm headset packaging is needed, follow the steps in Using Headset Samples

Launcher usage

After running, you will see a clean launcher interface.

Lanucher Homepage

Click the Samples button at the bottom center of the interface to access samples of all features.

Lanucher Samplepage

On the left side of the interface are feature categories, and on the right is a list of scene samples under each feature. Click different sample scenes to experience all the various features provided by EasyAR.

Additionally, at the bottom of the interface, demo videos for EasyAR Sense and EasyAR Mega features are provided, helping you better understand the capabilities and effects EasyAR can offer.

Must-read before running samples

Before running specific samples, you must complete the following key configurations; otherwise, the samples will not function properly:

  1. Set your API Key

    • Some samples (especially those involving cloud recognition, Mega cloud localization, etc.) require a valid API Key.
    • In the menu bar EasyAR > Sense > Configuration, find the corresponding fields that need to be filled for the sample.
    • Enter the App ID, API Key, and API Secret you applied for from the EasyAR Developer Center.
      Key Configuration
    • Important: If you do not have an API Key yet, some local feature samples (such as image tracking) may still run, but cloud features will fail. Be sure to visit the EasyAR Developer Center to create an application and obtain Keys.
  2. Configure XR/platform support:

    • If you are running headset-related samples, refer to Using Headset Samples.
    • Ensure your device (such as a phone or headset) is correctly connected and in developer mode.

Deep exploration of samples

The sample launcher is the best starting point for learning. We strongly recommend that you:

  • Run first, then study: Quickly experience the effects of each sample through the launcher to build an intuitive impression of EasyAR's capabilities.
  • Open scene source files: Each sample is an independent Unity scene file located in the Assets/Samples/EasyAR Sense Unity Plugin/[version]/__All Samples__/[feature name]/[sample name]/Scenes directory.
  • Study and read script code: In sample scenes, open the attached *.cs scripts to see how we call EasyAR APIs to implement specific features. This is the best way to learn API usage.

Through the sample launcher, you can quickly build an understanding of EasyAR SDK's capabilities. Enjoy your exploration!