Skip to main content

Tezos Unity SDK

The Tezos Unity SDK provides tools that let you access user wallets and blockchains in games and other Unity projects. You can use the SDK to:

  • Use a player's account as their account for a game and their wallet as their way of logging in to the game
  • Accept payments from players in tez (XTZ), the primary cryptocurrency of the Tezos and Etherlink blockchains
  • Use blockchains to create game assets, store player inventories, and transfer assets between players
  • Verify that users own specific game assets and allow them to transfer them to other players
  • Use smart contracts as backend logic for games

The SDK can connect to and use these blockchains:

Installation and use

For a walkthrough of installing and using the SDK in an existing Unity project, see Quickstart.

Upgrading from version 3

Version 4.0 has breaking changes. To upgrade, see Upgrading the Unity SDK.

Sample game

For information about a complete sample game that you can load locally and explore, see Sample game.

SDK objects

The SDK provides objects that you can use to interact with user wallets and with Tezos. See Unity SDK reference.

Dependencies

The Tezos SDK uses modified versions of the following libraries for communication:

  • Airgap Beacon SDK: Interacts with Tezos wallets through the Beacon standard for iOS, Android, and WebGL platforms.
  • Netezos: Interacts with Tezos wallets through the Beacon standard for Windows, Linux, and MacOS platforms. Also prepares parameters for smart contract calls and interprets complex data returned by the ReadView method.
  • WalletConnect: Interacts with EVM wallets with the WalletConnect protocol. To use WalletConnect wallets, you must install the Tezos WalletConnect Unity SDK.

The SDK also uses the Newtonsoft JSON Unity Package.

Supported Platforms

The SDK supports Windows, Linux, MacOS, iOS, Android, and WebGL platforms.

For information about the kinds of wallets the SDK supports, see Connecting accounts.