Setup

Setting up your Unreal Engine project to use the Immutable zkEVM API module is easy.

All you need to do is install the Unreal Engine plugin and enable the zkEVM API module in your project. Follow the steps below to get started.

💡Who is this for?

Developers who want to use the zkEVM API in Unreal.

Overview

To make using the Immutable zkEVM API module in your Unreal Engine project as easy as possible, we have added the API functionality to Immutable's Unreal Plugin. To use these features in your project, you need to install the plugin and enable the zkEVM API module in your project.

zkEVM API module

💡Supported Platforms and Versions

Refer to this page for the supported platforms and Unreal Engine versions.

1. Install Unreal Engine Plugin

The Immutable zkEVM API is available as a module of the Immutable Unreal Engine SDK plugin. To install the plugin, follow the installation procedure.

2. Enable zkEVM API Module

In order to start using the zkEVM API module, you need to enable the module in your unreal project. To do so, add the following line to your project's .Build.cs file. The below example shows how to add the module as public dependency in your project.

  PublicDependencyModuleNames.AddRange(new string[] 
  { 
    ...
    "ImmutablezkEVMAPI", 
    ...
  });

---

Related content

Unreal SDK Plugin

If you haven't installed the Unreal SDK plugin yet, follow these steps to get started.

Learn more

zkEVM APIs

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

Learn more

Unreal SDK Reference

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

Learn more