Guides and Tutorials
It includes tutorials, guides and detailed explanations of various processes and products in Immutable's suite.
What’s in the “Guides and Tutorials” section?
Immutable’s "Guides and Tutorials" section of the Developer Docs contains all the instructions a developer needs to carry out crucial functionality with Immutable’s products.
This section is separated into two main components - "Quickstart tutorials" and "Guides".
Code tutorials
Our "code tutorials" cover everything from deploying your first collection to building a game. Instructions are organised into detailed steps with code examples throughout. If you’re a beginner and looking to become familiar with Immutable’s suite of products, we’d strongly recommend trying these out.
Audience: Developers| Tutorial | Description |
|---|---|
| Build a game | This introductory tutorial covers setting up your environment, Passport, creating and interacting with in-game assets, displaying user inventories and in-game currencies. |
| Build a game with Unity | The “Build a game with Unity” tutorial will teach you how to integrate Immutable’s products into your Unity game. |
| Build a web‑based marketplace | This step-by-step tutorial will teach you how to building a web-based marketplace where people can buy and sell NFTs on Immutable zKEVM. |
| Build a marketplace with Unity | In this tutorial series, you will learn everything you need to know to build a marketplace in Unity on Immutable zkEVM. |
| Build a marketplace with Unreal | This tutorial series walks you through the in-game marketplace in our Unreal sample game and teaches you the principals behind how it works. |
| Deploy smart contracts | The “Deploy smart contracts” section covers everything related to deploying contracts on Immutable zkEVM, including ERC-721, ERC-20 and ERC-1155 contracts. You can learn how to deploy from Immutable Hub or by code. |
| Game launch checklist | Immutable’s “Game Launch Checklist” outlines the steps required for studios to launch their games. This list is designed to prevent unexpected technical issues and maximise a game's reach within Immutable's ecosystem partners and community. |
We also cover building a game in Unity or Unreal in a series of video tutorials:
| Video Tutorial Series | Description |
|---|---|
| Unity video series | This video series includes 14 videos covering topics like integrating with Immutable Passport in Unity, NFT minting and management, and utilizing NFTs in-game. It is an audiovisual version of the written “Build a game with Unity” tutorial. |
| Unreal video series | The “Unreal video series” teaches you how to integrate Immutable’s products into your Unreal game. It includes 15 videos covering topics like setting up the Unreal SDK, player authentication, NFT minting and management, and utilizing NFTs in-game. |
Guides
Immutable offers a series of “process guides” which are non-technical instructions on various processes related to Immutable's products. They also provide additional context on these topics, ensuring the reader has a complete understanding of a given subject.
Audience: DevelopersProduct Managers| Guide | Description |
|---|---|
| Set up your admin wallet | The “Set up your admin wallet” guide will walk you through the process of configuring your admin wallet for use on Immutable zkEVM. |
| Get Test IMX Tokens from the Immutable zkEVM Faucet | To deploy contracts and send transactions on the Immutable zkEVM Testnet, you'll need Test IMX Tokens ($tIMX). This guide will cover the purpose of Test IMX tokens and how you can get access to them. |
| Migrate your assets to zkEVM | The “Migrate your assets to zkEVM” guide will take you through your options for migration from another chain to Immutable zkEVM. It also covers our recommended migration strategy: Hard long tail migration. |
| Release a new collection | This section will guide you through releasing a new ERC-721 (NFT) collection to your users, either by primary sale or free mint. |
| In-game currencies (ERC‑20 tokens) | This guides section has everything you need to know about in‑game currencies, otherwise known as ERC‑20 tokens. |
| How to enable pre-approved transactions | Players who use Passport may be able to take advantage of pre-approved transactions when crafting or trading which is highly beneficial to in-game flow. |
| How to view all assets across multiple blockchains | This guide will walk you through displaying digital assets from multiple blockchains while using Passport as your digital identity and wallet provider. |
| sendTransaction Data Encoding | The “sendTransaction Data Encoding” guide covers argument encoding for calling smart contract methods. This is highly relevant to those using our Unity or Unreal SDK. |
Advanced Topics
This section is for experienced game developers who are wanting to understand the advanced features and complex architectures of Immutable zkEVM.
| Topic | Description |
|---|---|
| Transaction Data Encoding | In this guide you can learn how to encode data arguments when calling smart contract methods. |
| Wallet Management for Game Studios | This guide offers essential tips for secure wallet management in blockchain games. It covers secure processes, example scenarios for wallet setups, and best practices for handling various on-chain operations and funds. |
How do I use the “Guides and Tutorials” section?
A good place to start is our “Build a game” tutorial which introduces you to all the basics of deploying assets on Immutable zkEVM and creating your first game. Then, move onto guides and tutorials that are particularly relevant to your game or marketplace.
If you’ve got assets on another chain, have a read of the “Migrate your assets to zkEVM” guide or if you’re planning on deploying an ERC‑20 token, we’d recommend the “In-game currencies (ERC‑20 tokens)” section.
Beyond this, we have some articles on advanced topics like wallet management and data encoding for those looking to understand the more complex features of Immutable zkEVM.
If you can't find what you're looking for or need further assistance, please join our community of developers on Discord.