Table of Contents

Use AllSamplesLauncher to quickly experience EasyAR samples

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

Preparation

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

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

Please refer to the instructions in Quickstart and follow the steps.

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 the 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 and running on a mobile device, do not add headset-related scenes:

  • Combination_BasedOn_AppleVisionPro
  • Combination_BasedOn_Xreal
    Donot Load Headset

Problems encountered during packaging

During your compilation and packaging process, 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 enter your License Key in EasyAR Sense License
Missing Prefab Asset: 'XR Interaction Setup' Missing headset-related files Remove headset-related scenes from the packaging scene list. If you confirm that headset packaging is required, 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 enter the samples of all features.

Lanucher Samplepage

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

At the same time, at the bottom of the interface, there are also demonstration videos for EasyAR Sense and EasyAR Mega, which can help you better understand what features and effects EasyAR can provide for you.

Must-read before running samples

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

  1. Set your API key

    • Some samples (especially those involving cloud recognition, Mega cloud positioning, etc.) require a valid API key.
    • In the menu bar EasyAR > Sense > Configuration, find the corresponding fields that need to be filled in for the sample.
    • Enter the App ID, API Key, and API Secret you obtained from the EasyAR developer center.
      Key Configuration
    • Important note: If you do not yet have an API key, some local functionality samples (such as image tracking) may still run, but cloud functionality will fail. Be sure to visit the EasyAR Developer Center to create an application and obtain a key.

  2. Configure XR/platform support:

    • If you are running headset-related samples, follow the instructions in Using headset samples.
    • Ensure your device (such as a phone or headset) is properly connected and in developer mode.

Dive into samples

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

  • Run first, then study: Quickly experience the effect of each sample through the launcher to build an intuitive impression of EasyAR's capabilities.
  • Open the scene source file: 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 the script code: In the sample scene, you can open the attached *.cs script to see how we call the EasyAR API to implement specific features. This is the best way to learn how to use the API.

Through the sample launcher, you can quickly build an understanding of the EasyAR SDK's capabilities. Happy exploring!