Skip to main content
Version: Release 4.0.0

Migrating guide

Upgrading from ARDK 3.x to NSDK 4.0​

Installing NSDK 4.0 to a project with ARDK 3.x​

  1. Download NSDK 4.0 UPMs.
  2. In Unity, Remove the existing Lightship UMPs from Pacakage Manager.
  3. Add NSDK 4.0 UPMs using the package manager.
    • Note: Unity may re-open the project, and prompt for Safe Mode due to compilation failures. Click ignore and open the project anyway.
  4. Notice that there will be many compilation erros in the console. Follow the steps below to update your project to compile.

Update namespace references​

  1. Open your code editor (e.g., Rider or Visual Studio).
  2. Use your code editor's bulk replace operation with case-sensitive matching enabled.
  3. Replace using Niantic.Lightship.AR. with using NianticSpatial.NSDK.AR.
    • Note: If you have custom namespaces that use Niantic.Lightship.AR.*, either exclude them from the replacement or rename them accordingly.
  4. Replace using Niantic.ARDK.AR. with using NianticSpatial.NSDK.AR.
  5. Replace any other instances of Niantic.Lightship.AR or Niantic.ARDK.AR namespaces with NianticSpatial.NSDK.AR.

Update classnames​

All class names beginning with Lightship have been renamed to use the Nsdk prefix. Use your code editor's bulk replace operation to update the following class names:

  • LightshipSettingsHelper → NsdkSettingsHelper
  • LightshipOcclusionExtension → NsdkOcclusionExtension
  • LightshipMeshingExtension → NsdkMeshingExtension
  • LightshipNavMeshManager → NsdkNavMeshManager
  • LightshipNavMeshAgent → NsdkNavMeshAgent
  • LightshipSettings → NsdkSettings
  • LightshipNavMeshRenderer → NsdkNavMeshRenderer
  • LightshipNavMeshAgentPathRenderer → NsdkNavMeshAgentPathRenderer

Update property and method names​

Properties and methods containing Lightship have been renamed to use Nsdk. For example:

  • LightshipNavMeshManager.LightshipNavMesh → NsdkNavMeshManager.NsdkNavMesh

Updating files and version control (e.g. git)​

The main Settings file name changed to “NSDK Settings” from “Lightship Settings”. You should add “NSDK Settings.asset” and remove the “Lightship Settings.asset” file.

Updating authentication​

NSDK 4.0 no longer supports API key based authentication. Please update to use Enterprise Auth instead. First, follow these steps to remove API key from the project.

  1. Open Unity's Player Settings.
  2. Set NIANTICSPATIAL_NSDK_APIKEY_ENABLED in the script define symbols. This will reveal the API key in NSDK Settings.
  3. Go to NSDK Settings, and remove API key
  4. Return to player settings and remove NIANTICSPATIAL_NSDK_APIKEY_ENABLED to re-enable Enterprise Auth.
  5. To set up Enterprise Auth, see Getting started with enterprise auth

Features removed in NSDK 4.0​

  • SharedAR has been removed in NSDK 4.0.
  • APIs/Properties labeled as Obsolete in the previous versions are removed in NSDK 4.0

Updating VPS to VPS2​

While VPS is still available in NSDK 4.0, upgrading to VPS2 is recommended. See VPS2 and VPS2 migration guide.

ON THIS PAGE