Unity - Reown Docs

With AppKit, you can easily let people interact with multiple EVM and Solana compatible wallets and blockchains directly from your Unity game.

Install#

Let's get started by installing the AppKit package!

Prerequisites#

Unity 2022.3 or above
IL2CPP code stripping level: Minimal (or lower)
Target platform: Android, iOS, Windows, macOS, WebGL
Gamma color space
- If you need Linear color space, please open a GitHub issue

AppKit Package#

To install AppKit package via OpenUPM, you need to have Node.js and openupm-cli installed. Once you have them installed, you can run the following commands:

openupm add com.reown.appkit.unity

Open Advanced Project Settings from the gear ⚙ menu located at the top right of the Package Manager’s toolbar
Add a new scoped registry with the following details:
- Name: OpenUPM
- URL: https://package.openupm.com
- Scope(s): com.reown and com.nethereum
Press plus ➕ and then Save buttons
In the Package Manager windows open the add ➕ menu from the toolbar
Select Add package by name...
Enter the names of the following packages one by one:
- com.nethereum.unity
- com.reown.core
- com.reown.core.crypto
- com.reown.core.common
- com.reown.core.network
- com.reown.core.storage
- com.reown.sign
- com.reown.sign.unity
- com.reown.sign.nethereum
- com.reown.sign.nethereum.unity
- com.reown.appkit.unity
- com.reown.unity.dependencies
Press Add button

Note

If you encounter errors related to the com.unity.vectorgraphics package after installing AppKit, please install it manually from the Package Manager. Click the plus ➕ button in the Package Manager window, then select the Add package by name... option and enter com.unity.vectorgraphics.

Configure#

The minimum configuration required is filling in a Project ID and Metadata fields inside of AppKitConfig.

Don't have a project ID?

Head over to Reown Dashboard and create a new project.

await AppKit.InitializeAsync(    new AppKitConfig(        projectId: "YOUR PROJECT ID",        new Metadata(            name: "My Game",            description: "Short description            url: "https://example.com",            iconUrl: "https://example.com/logo.png"        )    ));

projectId: The project ID is a unique identifier for your project.
- If you don't have a Project ID, you can create one at Reown Dashboard.).
name: The project name is a human-readable name for your project.
description: The project description is a human-readable description for your project.
url: The project URL
iconUrl: Icon of the project.

Implement#

Add Reown AppKit prefab from Packages/Reown.AppKit.Unity/Prefabs to your scene.
Initialize AppKit from your script

public async void Start(){    var config = new AppKitConfig(...);    await AppKit.InitializeAsync(config);}

Connect account

public async Task ResumeSession(){    // Try to resume account connection from the last session    var resumed = await AppKit.ConnectorController.TryResumeSessionAsync();    if (resumed)    {        // Continue to the game        MyAccountConnectedHandler();    }    else    {        // Connect account        AppKit.AccountConnected += (_, e) => MyAccountConnectedHandler();        AppKit.OpenModal();    }}

Optional: Using Solana Unity SDK? You can keep using Solana.Unity.SDK's Web3 and route all signing through AppKit with our adapter. See the adapter section in Usage.

Examples and Test dApps#

Getting Support 🙋#

Reown is committed to delivering the best developer experience.

If you have any questions, feature requests, or bug reports, feel free to open an issue on GitHub!