Unity SDK

Native C# bindings for Passport authentication, wallet operations, and blockchain data queries.

Who is this for? Game developers using Unity who want to integrate web3 features, NFTs, and blockchain functionality into their games.

Platform Compatibility

Unity Version	Windows	macOS	Android	iOS
Unity 6	✅ Full support	✅ Full support	✅ Full support	✅ Full support
2021.3 LTS+	✅ Full support	✅ Full support	✅ Full support	✅ Full support

Unity 6 Android Users: If using Unity 6 with Android, you must set the Application Entry Point to Activity (not the default GameActivity). See Unity 6 Configuration below.

Prerequisites

Unity: 2021.3 LTS or later
.NET Standard: 2.1
UniTask: The UniTask package (v2.3.3) is a required dependency of our SDK. Follow the instructions here to install it.
Git LFS: The SDK repository uses Git Large File Storage to manage .dll files and other binary assets. Install Git LFS before cloning or Unity Package Manager may fail to download binary dependencies correctly.

Packages

The SDK provides the following components:

Package	Purpose	Prerequisites
Passport	Authentication and wallet operations	-
ZkEvmApi	REST API for zkEVM (list NFTs, orders, and more)	-

See the Installation section below for setup instructions.

Installation

Install UniTask v2.3.3 or later The UniTask package is a dependency of our SDK.
Install Git LFS
Git LFS must be installed before adding the SDK. The SDK contains .dll files stored in Git LFS that won’t download correctly otherwise.
Add the Immutable SDK:

Package Manager
manifest.json

Open Window → Package Manager
Click + and select Add package from git URL…
Enter https://github.com/immutable/unity-immutable-sdk.git?path=/src/Packages/Passport and click Add

Open your project’s Packages/manifest.json file
Add the following in the dependencies block:

"com.immutable.passport": "https://github.com/immutable/unity-immutable-sdk.git?path=/src/Packages/Passport"

Install a Specific Version

To install a specific version of the SDK using either method above, append # followed by the version tag to the git URL:

https://github.com/immutable/unity-immutable-sdk.git?path=/src/Packages/Passport#v1.0.0

For mobile platform setup (Android, iOS), see Platform-Specific Configuration.

Unity 6 Configuration

Unity 6 Android Required: If using Unity 6 with Android, you must configure the Application Entry Point.

Go to Project Settings → Player → Android → Other Settings → Configuration
Set Application Entry Point to Activity (not GameActivity)
Open AndroidManifest.xml and remove the UnityPlayerGameActivity activity block; keep only the UnityPlayerActivity block

Platform-Specific Configuration

Windows
macOS
Android
iOS

Platform Requirements

Windows: 10 or later

Scripting Backend Support

Backend	Support	Notes
Mono	✅ Fully supported	Uses default Unity Web Browser (UWB)
IL2CPP	⚠️ Requires custom WebView	See Advanced Configuration for Vuplex setup

Default WebView Setup

The SDK uses Unity Web Browser (UWB) by default on Windows. UWB is not bundled with the SDK, so you must install it.

Add the VoltUPR registry and required scopes, then install UWB via the Package Manager. See the UWB GitHub repo and VoltUPR setup guide.
Import these packages:
- dev.voltstro.unitywebbrowser
- dev.voltstro.unitywebbrowser.engine.cef
- dev.voltstro.unitywebbrowser.engine.cef.win.x64
Confirm UWB_WEBVIEW is present in your project after the packages are installed.

For IL2CPP builds, use a custom WebView like Vuplex. See Advanced Configuration.

Platform Requirements

Minimum Android Version: 10 or later (API Level 24+)
Target API: 33 or higher recommended

Enable custom manifest and Gradle

Go to Edit → Project Settings → Player → Android
Expand Publishing Settings
In Build, enable Custom Main Manifest and Custom Main Gradle Template

Unity generates Assets/Plugins/Android/AndroidManifest.xml and Assets/Plugins/Android/mainTemplate.gradle. Edit these files (or your existing custom ones) as below.

AndroidManifest.xml

Add this activity inside the <application> element. Set android:scheme and android:host to match the redirect URIs you use in Passport (e.g. mygame and callback for mygame://callback):

<activity
  android:name="com.immutable.unity.RedirectActivity"
  android:exported="true" >
  <intent-filter android:autoVerify="true">
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data android:scheme="mygame" android:host="callback" />
    <data android:scheme="mygame" android:host="logout" />
  </intent-filter>
</activity>

mainTemplate.gradle

Add the Chrome Custom Tabs dependency inside the dependencies block:

implementation('androidx.browser:browser:1.5.0')

For androidx.browser:browser:1.5.0, Target API Level must be at least 33. Set it under Edit → Project Settings → Player → Android → Other Settings → Target API Level.

Manual Manifest Configuration (Advanced)

If automatic merging doesn’t work for your project, you can manually configure AndroidManifest.xml:

<activity android:name="com.unity3d.player.UnityPlayerActivity"
          android:exported="true">
  <!-- ... existing intent filters ... -->

  <!-- Add deep link intent filter -->
  <intent-filter android:autoVerify="true">
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data android:host="callback" android:scheme="mygame" />
    <data android:host="logout" android:scheme="mygame" />
  </intent-filter>
</activity>

Platform Requirements

iOS Version: 15.2 or later

URL Scheme Configuration

Add your custom URL scheme to Info.plist:

<key>CFBundleURLTypes</key>
<array>
    <dict>
        <key>CFBundleURLSchemes</key>
        <array>
            <string>mygame</string>
        </array>
    </dict>
</array>

Or configure in Unity:

Go to Edit → Project Settings → Player → iOS → Other Settings → Supported URL schemes
Increase Size by 1
Enter your URL scheme in the new Element slot (e.g. mygame for mygame://callback)

Deep Link Configuration

The SDK handles deep links automatically. Ensure your redirect URIs match your configured URL scheme.

Your redirect URIs (like mygame://callback) must use the same URL scheme that you configure in your platform settings:

iOS: Only the scheme needs to match (e.g., mygame in mygame://callback)
Android: Both the scheme AND host must match (e.g., mygame and callback in mygame://callback)

See Initialize Passport for authentication setup.

// Must match your URL scheme
passport = await Passport.Init
(
    clientId: "YOUR_CLIENT_ID",
    environment: Environment.Sandbox,
    redirectUri: "mygame://callback",      // ← mygame matches URL scheme config
    logoutRedirectUri: "mygame://logout"
);

Next Steps

Getting Started

Configure Your Project

Set up credentials and OAuth client in Immutable Hub

Authentication

Initialize Passport and implement login

Wallet Operations

Access wallet addresses and balances

Game Bridge Architecture

Understand SDK internals and custom engine integration

Additional Resources

Sample Game

Complete sample project

Advanced Configuration

Custom WebView, IL2CPP support

FAQ

Common questions and troubleshooting

GitHub

SDK source code and samples

TypeScript

Unity

Unreal

Platform Compatibility

Prerequisites

Packages

Installation

Install a Specific Version

Unity 6 Configuration

Platform-Specific Configuration

Platform Requirements

Scripting Backend Support

Default WebView Setup

Platform Requirements

Platform Requirements

Enable custom manifest and Gradle

AndroidManifest.xml

mainTemplate.gradle

Manual Manifest Configuration (Advanced)

Platform Requirements

URL Scheme Configuration

Deep Link Configuration

Next Steps

Getting Started

Configure Your Project

Authentication

Wallet Operations

Game Bridge Architecture

Additional Resources

Sample Game

Advanced Configuration

FAQ

GitHub

TypeScript

Unity

Unreal

​Platform Compatibility

​Prerequisites

​Packages

​Installation

​Install a Specific Version

​Unity 6 Configuration

​Platform-Specific Configuration

​Platform Requirements

​Scripting Backend Support

​Default WebView Setup

​Platform Requirements

​Platform Requirements

​Enable custom manifest and Gradle

​AndroidManifest.xml

​mainTemplate.gradle

​Manual Manifest Configuration (Advanced)

​Platform Requirements

​URL Scheme Configuration

​Deep Link Configuration

​Next Steps

​Getting Started

Configure Your Project

Authentication

Wallet Operations

Game Bridge Architecture

​Additional Resources

Sample Game

Advanced Configuration

FAQ

GitHub

Platform Compatibility

Prerequisites

Packages

Installation

Install a Specific Version

Unity 6 Configuration

Platform-Specific Configuration

Platform Requirements

Scripting Backend Support

Default WebView Setup

Platform Requirements

Platform Requirements

Enable custom manifest and Gradle

AndroidManifest.xml

mainTemplate.gradle

Manual Manifest Configuration (Advanced)

Platform Requirements

URL Scheme Configuration

Deep Link Configuration

Next Steps

Getting Started

Additional Resources