本文へスキップ
バージョン： 3.15

Setting Up the Niantic SDK for Unity

Important!

ARDK 3.13.0 is launching April 23, 2025. All versions before 3.13.0, including ARDK 2.x, will enter a 6-month support window starting May 1, 2025 and stop working on November 1, 2025. See 3.13.0 Release Notes. Questions? support@nianticspatial.com

To set up the SDK, you will download and install Unity, then install the ARDK Unity packages and set up Unity for the platform your AR experience will run on. After that, you will authenticate Lightship in Unity with your API key, perform any additional setup your platform device requires, and set up the basic requirements for an AR scene in Unity.

Beta Content

The Lightship Magic Leap 2 integration is in beta, so some features may not work as expected.

Download and Install Unity​

Download Unity. We support Unity 6 (with 6000.0.36f1) and Unity 2022 LTS (with 2022.3.57f1).

Attention!

Unity 2022 LTS users will need to manually upgrade Visual Scripting from 1.9.0 to 1.9.1 or higher via the Package Manager to avoid a SessionStateChangedEventUnit error.

Create a Project and Install ARDK​

プロジェクトを作成し、ARDKをインストールする​

  1. Universal 3D（Core） テンプレートで新しいUnityプロジェクトを作成します。
  2. Unityプロジェクトで、 Window トップメニューを開き、 Package Manager を選択します。
  3. Package Manager タブのプラスメニューから、 **Add package from git URL...**を選択してください。

    Package Manager menu

  4. https://github.com/niantic-lightship/ardk-upm.git と入力します。
    1. 新しいInput System PackageをARFoundation 5.0用に有効化するよう求められたら、 Yes をクリックしてください。 この際、Unityエディターの再起動が必要になることがあります。
  5. SharedARパッケージを追加するには、 : https://github.com/niantic-lightship/sharedar-upm.git を使用して同じ手順を繰り返します。

特定のARDKバージョンを使用する場合は、リリースページ(ardk-upm, sharedar-upm)から、 .tgz をダウンロードしてください。 その後、上記のインストール手順に従い、Git URLではなく、「Add package from tarball」を選択します。

Attention!

If you are using or plan to use the Universal Render Pipeline (URP), refer to How to Set Up ARDK with the Universal Render Pipeline for additional setup instructions.

Create a Lightship Account and Add API Key​

  1. Open the Lightship top menu, then select Settings to open the Lightship Settings menu. Click on Get API Key under Credentials. This should open the lightship.dev website in a browser window.
  2. Create a new Lightship account if you need to, then log in.
  3. Open the Projects page, then select an existing project or create a new one by clicking New Project.
  4. In your project's Overview, copy the API Key by clicking the copy icon next to it.
  5. Return to the Lightship Settings window in Unity and paste your API Key into the API Key field.

Activate the XR Loader for Your Mobile Platform​

注意

In Unity version 2022.3.10f1 or newer, you might see a benign error in the console after following these steps.

  1. Open the Lightship top menu, then select XR Plug-in Management.
  2. In the XR Plug-in Management menu, select the Android tab, then check the box labeled Niantic Lightship SDK + Google ARCore.

Configure the Build Platform​

  1. Open the Build Settings window by selecting File > Build Settings.
  2. Select iOS or Android, then click Switch Platform. After the progress bar finishes, click Player Settings. Select your platform from the tabs, scroll down to Other Settings, and change the following settings:
  • Rendering - Uncheck Auto Graphics API. If Vulkan appears in the Graphics API list, remove it.
  • Identification - Set the Minimum API Level to Android 7.0 'Nougat' (API Level 24) or higher.
  • Configuration - Set the Scripting Backend to IL2CPP, then enable both ARMv7 and ARM64.
Attention!

If you are using Unity 2022.3.15f1 or older, building to Android requires a custom Gradle installation.

Click here to reveal the Gradle installation instructions
  1. Download and install Gradle 6.7.1 from the Gradle Releases page.
  2. Replace the default Gradle install in Unity:
  3. In Unity, open Preferences > External Tools > Android.
  4. Uncheck the box labeled Gradle installed with Unity (recommended), then replace the path with your local installation of Gradle 6.7.1.
Custom Gradle Build Settings
ヒント

If you are building through the command line, you can customize the Gradle path by setting AndroidExternalToolsSettings.gradlePath in your Unity build script.

  1. Set your Build Target to Android.

Next Steps​

Setting Up a Basic AR Scene​

自分のARプロジェクトを作り始めるには、まず空のARシーンを作ることから始めます：

  1. 新しいベーシックシーンを作成する：
    1. メインメニューから、 File > New Scene の順に選択します。
    2. Basic (Built-in) を選択し、 Createをクリックする。
  2. Main Camera を右クリックし、 Deleteを選択する。
  3. ARSession と XROrigin を新しいシーンに追加する
    1. Hierarchyで新しいシーンを選択してください。
    2. メインメニューから、 GameObject > XR > AR Session の順に選択します。
    3. これを繰り返して XR Origin (Mobile AR) を追加します。
  4. File > Save の順に移動し、シーンを保存します。
ヒント

Save As Scene Template を選択すると、次回から New Scene ダイアログでこのシーンを選択できます。

Further Reading​

From here, proceed to the Sample Projects page to try out the features or to the How-To page to experiment with a guided tutorial. If you instead have a previous ARDK project you would like to convert to ARDK 3, see our Migration Guide.