Quickstart for ARCore Extensions for Android

Get started with building your Android apps using AR Foundation.

About AR Foundation

AR Foundation is Unity's high level, cross platform API to support Augmented Reality. AR Foundation lets you write your app once, and build for either Android or iOS.

For details about AR Foundation, see Unity's AR Foundation page.

Requirements

Using ARCore Extensions for AR Foundation to build for Android requires the following hardware and software.

Hardware

Software

The following Unity packages are required, they will be installed automatically by the Unity package manager's dependency management system when you install the ARCore Extensions package in the next step:

  • AR Foundation package version 2.1.4.

  • ARCore XR Plugin package version 2.1.1.

    You may encounter compatibility issues if you do not use these versions.

Get the ARCore Extensions package

The ARCore Extensions for AR Foundation package is available from GitHub:

  1. Download the latest arcore-unity-extensions-*.tgz from the GitHub releases page.

  2. Extract the downloaded archive to a local folder. Make sure it's a location that is convenient -- after you install the package into your project, you won't be able change the folder's location or contents without first uninstalling the package. You may reinstall the package after changing the folder location.

Create a new project and import the ARCore Extensions package

  1. Open Unity and create a new 3D project.

  2. To import the ARCore Extensions package downloaded from GitHub into your project, follow these steps:

    1. Open the Package Manager (choose Window > Package Manager).

    2. In the top left corner of the Package Manager, click the + (plus) button. Choose Add package from disk…

      Add package from disk in Unity Package Manager

    3. Locate the local folder where you unzipped the archive, and select the package.json file, then click Open.

    4. Wait a moment while Unity installs this and dependent packages into your project.

Configure project settings

  1. Go to File > Build Settings to open the Build Settings window.
  2. Select Android and click Switch Platform.
  3. In the Build Settings window, click Player Settings.
  4. In the Settings window, configure the following:
    Setting Value
    Player Settings > Other Settings Uncheck Multithreaded Rendering
    Player Settings > Other Settings > Rendering Uncheck Auto Graphics API
    If Vulkan is listed under Graphics APIs, clear it.
    Player Settings > Other Settings > Package Name Create a unique app ID using a Java package name format.
    For example, use com.example.helloAR
    Player Settings > Other Settings > Minimum API Level Android 7.0 'Nougat' (API Level 24) or higher
    (For AR Optional apps, the Minimum API level is 14.)

Next Steps