Unity-Technologies/arfoundation-samples

AR Foundation samples

AR Foundation enables you to create multi-platform augmented reality (AR) apps with Unity. This GitHub repository contains AR Foundation samples, the official AR Foundation sample app that you can download, build to your device, and use as a starting point for your own projects.

This project demonstrates the following AR Foundation implementations:

Each AR Foundation feature is used in a minimal sample scene with example code that you can modify or copy into your project.

Which version should I use?

The main branch of this repository uses AR Foundation 6.3 and is compatible with Unity versions 6000.0 and newer. Refer to the following table for links to other branches of this repository and their corresponding Unity versions.

How to use these samples

Build and run on device

You can build the AR Foundation Samples project directly to device, which can be a helpful introduction to using AR Foundation features for the first time.

To build to device, follow the steps below:

1. Install Unity 6000.0 or newer, and clone this repository.
2. Open the Unity project at the root of this repository.
3. As with any other Unity project, go to the Build Profiles window, select your target platform, and build this project.

Understand the sample code

All sample scenes in this project can be found in the Assets/Scenes folder. To learn more about how each scene works, refer to the AR Foundation samples documentation, which is now published as part of the AR Foundation user manual.

Community and feedback

Refer to sections below to understand how to provide different kinds of feedback to Unity.

AR Foundation bug reports

To report a bug in AR Foundation, please file a bug. You may also submit a GitHub issue, but GitHub issues are unofficial, and we will close your GitHub issue if it does not contain an official bug ID number. The best way to ensure that your issue is addressed is to file a bug using Unity's official bug reporting process.

AR Foundation feature requests

To request a new feature in AR Foundation or related packages, use Unity's XR Roadmap. Click on the AR Foundation tab, then scroll down to Submit a New Idea.

Contributions to this repository

We are not accepting pull requests at this time. If you find an issue with the samples or would like to request a new sample, please submit a GitHub issue.