Skip to main content

Installing the Lightship Maps SDK

To use Lightship Maps for Unity, you must install the Lightship Maps SDK Unity package using the Unity Package Manager. The package is available via direct download as a compressed tarball archive or via GitHub. 

  <img src={add_package_from_tarball} alt="Add package from tarball" width="800px"/>

Installing the Lightship Maps SDK via Github URL​

  1. Create a new Unity project with the 3D (Core) template.
  2. In your Unity project open the Package Manager by selecting Window > Package Manager
    1. From the plus menu on the Package Manager tab, select Add package from git URL...
    2. Enter https://github.com/niantic-lightship/maps-upm.git Click Yes to activate the new Input System Package for AR Foundation 5.0 (if prompted)

Installing the Lightship Maps SDK via Direct Download​

  1. Download the plugin packages (.tgz) from the latest release.
  2. In your Unity project open the Package Manager by selecting Window > Package Manager
    1. From the plus menu on the Package Manager tab, select Add package from tarball...
    2. Navigate to where you downloaded the Maps UPM, select the .tgz file you downloaded, and press Open. This will install the package in your project's Packages folder as the Niantic Lightship Maps SDK. Click Yes to activate the new Input System Package for AR Foundation 5.0 (if prompted)

Use your Lightship.dev Account​

You will need an account on https://lightship.dev to supply an API key for the Maps SDK to use. If you do not have an account, go to https://lightship.dev/signin/create-account to create one.

Adding your API Key to your Unity Project​

  1. Visit lightship.dev.

  2. Sign in and visit the Projects section. Select an existing project or create a new one with New Project.

  3. Under your project Overview, click the copy icon next to your API Key.

  4. Open the API Key Helper in Unity by selecting Lightship > Maps SDK > API Key Helper.

    Add package from tarball

  5. In the API Key Helper, if your Current API Key is blank, or you want to replace it with the key you just copied, paste the new key next to Lightship API Key and press Setup.

    Add package from tarball

  6. If you get the message "Lightship API Key has been set correctly", press OK.

    caution

    Upon playing a scene with the LightshipMap prefab, if the Lightship API key is not set to a valid key, an invalid-key notification window will appear and then the API Key Helper will open for you to enter a valid key.