Flutter x Unity as a Library (+Lightship ARDK) Template

日本語版 | English

Table of Contents

• 1. About
  • 1.1 Supported Platforms
  • 1.2 Dependencies
    • 1.2.1 Flutter
    • 1.2.2 Unity
• 2. How to Set Up
  • 2.1 Flutter
  • 2.2 Unity
    • 2.2.1 Opening the Unity Project
    • 2.2.2 Setting the Lightship API Key
    • 2.2.3 Build Unity
• 3. Known Issues
  • 3.1 Flutter
  • 3.2 Unity

1. About

A template project integrating Flutter with Unity as a Library, featuring Niantic Lightship ARDK.

1.1 Supported Platforms

This project has been tested on the following platforms:

• Android
• iOS

1.2 Dependencies

1.2.1 Flutter

• flutter-unity-widget
• fvm
• flavorizr

1.2.2 Unity

• Unity 6.0 LTS (tested on 6000.0.59f2)
• ARFoundation 6.0.6
• ARKit/ARCore 6.0.6
• Lightship ARDK 3.16.0

2. How to Set Up

2.1 Flutter

You can set up the Flutter environment using the make command:

make setup

For other commands, refer to docs/HOWTOUSE.md.

2.2 Unity

2.2.1 Opening the Unity Project

Open the project via Unity Hub.

The Unity project is located at:

unity/unity-niantic

2.2.2 Setting the Lightship API Key

Please refer to the Lightship documentation.

Navigate to ProjectSettings/XR Plugin Management/Niantic Lightship SDK:

2.2.3 Build Unity

Use Flutter/Export XXX to build the Unity project:

3. Known Issues

3.1 Flutter

No known issues at this time.

3.2 Unity

1. (Editor) "State comes from an incompatible keyword space Expected: From shader: 'Simulation/Standard Lit', Incompatible keyword states"

   • This is a Unity bug. Please refer to the IssueTracker.

2. (Editor) "The following asset(s) located in immutable packages were unexpectedly altered."

   • This is an ARFoundation bug. Please refer to the IssueTracker.

3. (Editor) "User ID is missing. Please set a unique ID using PrivacyData.UserId for data management purposes."

   • For more information, see forum.