Skip to main content
Version: v2

Unreal SDK

The Immutable SDK for Unreal helps you integrate your game with Immutable Passport.
info

New Release: PKCE Authentication for Windows (Alpha)​

Important Dates:

  • Release Date: 6 May 2025
  • Status: Alpha

Affected Components:

  • PKCE Authentication flow in Unreal SDK
  • Windows platform

Impact: PKCE Authentication for Windows is now available in alpha. This new authentication method will eventually replace Device Code Authorisation, providing a more seamless and secure login experience. We encourage developers to begin testing and implementing PKCE for Windows in their applications.

Unreal Engine Version and Platform Compatibility​

The following Unreal Engine versions and platforms are currently supported by the team. Ensure that your development environment matches these versions for optimal performance with the SDK. Using versions outside of the supported ones is not recommended and may lead to issues.

⚠️Warning
Android and iOS are not officially supported.
Unreal Engine VersionWindowsmacOSiOSAndroid
5.5.x✅✅✅✅
5.4.x✅✅✅✅
5.3.x✅✅✅✅
5.2.x and below❌❌❌❌

Automation Test Reports​

We maintain automation test reports to validate the SDK's functionality across supported versions and platforms.

Please refer to the Unreal SDK Repository for access to these test reports.

Overview​

The Immutable SDK for Unreal provides everything you need to integrate your game with Immutable's web3 infrastructure, including:

  • Passport Integration - Secure authentication and wallet management
  • zkEVM Transactions - Send blockchain transactions seamlessly
  • Asset Management - Handle digital assets and NFTs
  • Marketplace Integration - Connect with Immutable's orderbook

Getting Started​

For detailed implementation guides, choose your integration path:

Implementation Guides
Passport Setup & Usage
Complete guide for setting up and using Passport authentication, wallet management, and blockchain functionality in your Unreal game.
Get started
API Reference
Detailed API documentation with method signatures, parameters, and examples for all Passport functionality.
Explore

Quick Start​

  1. Setup - Install and configure the Unreal SDK
  2. Login - Implement user authentication
  3. Initialise Wallet - Connect user's blockchain wallet
  4. Send Transactions - Interact with smart contracts
💡Blueprint Examples
See the included sample widgets in All → Plugins → Immutable Content in the Unreal Editor content browser for examples of how to use the plugin in Blueprint. If you don't see a Plugins folder under All you may need to enable Show Plugin Content in the content browser's Settings menu.

SDK Components​

The Unreal SDK provides comprehensive functionality for integrating with Immutable's web3 infrastructure:

Passport​

Complete authentication and wallet management solution with methods for login, logout, wallet initialisation, and blockchain interactions.

View Passport Documentation →

Key features:

  • Secure user authentication (PKCE & Device Code Authorisation)
  • Non-custodial wallet management
  • zkEVM transaction support
  • EIP-712 message signing
  • Credential management

Orderbook​

Integration with Immutable's marketplace for trading digital assets.

View Orderbook Reference →

Additional Resources​

💡C++ Implementation
Check out the ImmutablePassport.h file for the C++ Passport API. Follow the same sequence of steps as the Blueprint widget examples for implementation guidance.

Additional Resources​

Sample Blueprints
Explore sample blueprints for examples of how to use the Immutable Unreal SDK in your projects.
View on GitHub
Sample Game
Check out our complete sample game implementation to see how the Immutable Unreal SDK works in practice.
View on GitHub
Unreal Marketplace Tutorial
Follow our step-by-step tutorial to build a marketplace in Unreal using the Immutable SDK.
Start Tutorial

IMX Whitepaper • IMX Tokenomics • Block Explorer • Careers • Contact Us