Setup

Setting up your Unity project to use the Immutable zkEVM API package is easy.

All you need to do is install the zkEVM API package and enable it in your project's manifest. Follow the steps below to get started.

💡Who is this for?

Developers who want to use the zkEVM API in Unity.

Overview

To make using the Immutable Orderbook in your Unity project as easy as possible, we have added the orderbook functionality to Immutable's Unity package. To use these features in your project, you need to install the zkEVM API package and enable it in your project's manifest.

Install the zkEVM API package

💡Supported Platforms and Versions

Refer to this page for the supported platforms and Unity versions.

Install from a Git URL

Via UPM window

1. Open the Package Manager
2. Click the add + button and select "Add package from git URL..."
3. Enter https://github.com/immutable/unity-immutable-sdk.git?path=/src/Packages/ZkEvmApi and click 'Add'

Via manifest.json

1. Open your project's Packages/manifest.json file
2. Add "com.immutable.api.zkevm": "https://github.com/immutable/unity-immutable-sdk.git?path=/src/Packages/ZkEvmApi" in the dependencies block

---

Related content

Unity SDK packages

For the full list of available Unity SDK packages, check out the packages section of the Unity SDK page.

Learn more

zkEVM APIs

Find out more information on what's available through the APIs and how to use them.

Learn more

Unity SDK Reference

For more information on all the available methods in our Unity SDK, check out the SDK Reference.

Learn more