Getting Started
Templates

About This Guide

In this guide, you will learn how to use Lightship Hub, which contains templates that you can use to quickly get building on ARDK.

To start working with Lightship Hub, you need to install ARDK and Lightship Hub packages.

Start by creating an empty Unity project.

Install the ARDK Package [01:06]

Download the Lightship ARDK unitypackage (the download button can be found on the he right hand side of this page, under the table of contents). Install the package from the menu under Assets > Import package > Custom package…

Locate the downloaded package and start importing it.

Templates 1

Make sure you import all assets on the Import Unity Package window.

Templates 2

Install Lightship Hub Package [01:47]

Repeat the same process to install Lightship Hub.

Download the Lightship Hub unitypackage (the download button can be found on the he right hand side of this page, under the table of contents). Install the package from the menu under Assets > Import package > Custom package…

Locate the downloaded package and start importing it.

Templates 3

Make sure you import all assets on the Import Unity Package window.

Templates 4

To start working with Lightship, you are required to set up a License Key.

Navigate to the lightship.dev site and on your dashboard to create your License Key.

Templates 5

Open the Configuration Helper Window under Lightship > Lightship Hub > Configuration Helper Window

Templates 6

Add your API Key and press setup to finish the setup.

Templates 7

Lightship Menu [02:52]

Your project has a new menu called Lightship where you can find templates, help, and tools.

You can access the Welcome window where you can find a more detailed list of the templates.

Templates 9

Different Types of Templates [03:14]

Templates are divided in different topics such as AR Fundamentals and Contextual Awareness. Within each topic you’ll be able to find simple to complex templates that will help you jumpstart your project easily.

Let’s use the Object Placement template as an example.

Object Placement uses plane detection to place an object in the scene. This template will create a series of objects and set up a scene with all the scripts and components you need to start working, so you’ll have a fully working scene that’s ready to be exported.

Templates 10
Templates 11

All templates include a Mockup Room that lets you try the AR project in game view mode. Just click on Play to test the scene. HOWEVER, if this is your first time using templates, you’ll need to select a mock environment to test out your scene with. Go to the Lightship Menu > ARDK > Virtual Studio. and Select Mock, then choose either the indoor or outdoor environment. In the game view, you’ll be able to see the template in action and interact with it in the mock environment

You are able to customize all the templates to make them your own. To add your own content to the template, replace the “[REPLACE ME]” object with your own 3D model.

Once you have changed the object with your own, this will be used throughout the project instead of the placeholder provided in the template.

Templates 12

All templates provide an option to change the scene behavior. Select the ARController and the inspector panel will show the different options available.

Templates 13

Conclusion [04:32]

Congratulations! You have successfully learned how to use templates to build your projects using Niantic’s Lightship Augmented Reality Development Kit. Now you can test out what you built on your device. If you need guidance on doing that, check-out our "The Basics" video!"

Hopefully you’ve seen how easy it can be to add augmented reality to your project by leveraging the Lightship ARDK.

What Now?

Check out our Tutorials page for several tutorials over specific Lightship topics Join the Lightship Community Discord to discuss Lightship projects with other developers Follow Lightship on Twitter and Instagram to see projects built with Lightship and stay in the know with updates to the platform

Happy Building!

Ready to build?