Skip to main content

Getting Started

In this section, you'll learn how to add Plankton to your Unity projects.

Android Prerequisite​

Use a Unity LTS editor containing the CVE-2025-59489 security fix. The minimum patched public releases are:

Unity releaseMinimum patched version
Unity 2021.3 LTS2021.3.45f2
Unity 2022.3 LTS2022.3.62f2
Unity 6.0 LTS6000.0.58f2

Use these versions or a later patched release in the same line. Extended-support (xLTS) branches require 2021.3.56f2 or 2022.3.67f2 respectively. For other Unity 6 release lines, check the fixed versions in Unity's security advisory. A higher version number in a different branch does not by itself confirm that the fix is included.

Android Build Support​

In Unity Hub, install Android Build Support for your editor, including Android SDK & NDK Tools and OpenJDK. Switch your project's build platform to Android before generating plugins or building.

Minimum Android version​

Set Minimum API Level to 24 or higher in Edit > Project Settings > Player > Android > Other Settings.

Android build tools​

Gradle is the tool Unity uses to build Android apps. Choose an Android Gradle plugin (AGP), Gradle, and Java Development Kit (JDK) combination compatible with your Unity editor and selected Plankton features. There is no single Gradle or Android SDK Build Tools version required for every project; lower versions can work when they meet your selected dependencies' requirements.

  1. Start with the Android tools installed through Unity Hub. Keep the NDK supplied with your editor.
  2. Install any SDK platform and Build Tools required by your selected dependencies in the SDK selected in Preferences > External Tools. Set Target API Level in Player Settings > Android > Other Settings to meet your dependencies and publishing requirements. Keep Minimum API Level at 24 or higher.
  3. If your project needs different Gradle or Java tools, use Plankton's optional Android build tools settings after importing the plugin. Leave these options off when your existing setup is compatible.

See Unity's Android dependency guidance and the AGP and Gradle compatibility table when choosing tools.

iOS Prerequisite​

Minimum iOS version​

You can build your games with target minimum iOS version 15.0 or higher

You can change target minimum iOS version in Unity from Edit > Project Settings > Player > Other Settings

Cocoapods​

Plankton is using Cocoapods as the dependency manager in iOS platform. You should install cocoapods on your macOS by simply running this command:

sudo gem install cocoapods
info

For more information on the installation of cocapods and how to install it sudo-less visit this guide

Xcode​

To build and publish iOS projects using Plankton, you'll need Xcode version 15 or later installed on your macOS system.

note

Always open your xcode project by opening the Unity-iPhone.xcworkspace file.

Get Plankton​

You can download Plankton from the Unity Asset Store.

Add Plankton to Your Project​

Take the following steps to import Plankton to your project:

  1. In Unity, select Window > Package Manager

  2. Inside the Package Manager, go to "My Assets" under Packages

  3. Select the All-in-one Cross-platform Plugins... from the list and hit the download button

  4. After the package is downloaded, you can hit the import button and bring Plankton to your project

  5. Open Edit > Project Settings > Plankton, finish Android build-tool setup if needed, and select your features. Click Generate Plugins Now, then use Unity's Build or Build And Run. See Configuration for the available settings.