This guide is for Unity developers getting started with the Vuforia AR Starter Kit from the Unity Asset Store.
The Vuforia AR Starter Kit contains a selection of complete augmented reality scenes to get you started developing for handheld and headworn devices running Android, iOS, and UWP. Each scene implements a feature of the Vuforia Engine, which enables you to track images, objects and your environment. You can easily add your own Unity content to these scenes, to create your own augmented reality experiences.
This guide will cover how to:
- Download the Vuforia AR Starter Kit
- Register and retrieve a free license key
- Work with the Vuforia AR Starter Kit
Download the Vuforia AR Starter Kit
Download the Vuforia AR Starter Kit from the Unity Asset Store. Select Open In Unity to add it to a new or existing Unity project.
Register for Vuforia
If you are not already a Vuforia developer, you will first need to create a Vuforia Developer Account.
Get a Free Development License Key
|1. Login and navigate to the License Manager on the Vuforia Developer Portal then select Add License Key.|
|2. Select the Development project type
The Development license is free to try. If you distribute your app, you will be required to purchase the appropriate consumer or enterprise plan.
|3. Provide a name for your app
4. Press Next then confirm your selection on the next page
|5. You'll see your app listed in the License Manager. Click on it.|
|7. Your app’s license key is shown in the License Key field – copy it.
You’ll need to paste this key into your Unity project.
Adding a License Key to Your Project
In Unity, your license key should be added to the App License Key field on the VuforiaConfiguration asset which is accessible from the ARCamera's Inspector panel via the Open Vuforia Configuration button. You can also search for VuforiaConfiguration in the Project panel.
Working with the Vuforia AR Starter Kit
The AR Starter Kit includes scenes that show how to use the following Vuforia features:
- Image Targets
- Object Recognition
- Cylinder Targets
- User Defined Targets
- Smart Terrain
- Cloud Recognition
- Text Recognition
- Virtual Buttons
|The following sample scenes use printed images. You can find PDF versions of these images that are ready to print in the Editor/Vuforia/ForPrint folder.|
Running a Vuforia Scene in Play Mode
Building the sample scenes
Adding your own content
It is very easy to customize the sample scenes. Simply add your digital content as a child of the target it should be associated with. This will cause the content to be rendered when the target is recognized and to follow the target within the field of view of the camera. All of Vuforia's features use this same contention when authoring scenes in Unity.
The teapot model is a child of the Stones ImageTarget. When the Stones target is detected, the teapot will be rendered, and will move with the target in the camera's field of view.