Setup

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

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

💡Who is this for?

Developers who want to build an in-game marketplace in Unity.

💡Alpha version

This module is experimental and may change in the future. We recommend using it for testing purposes only.

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 Orderbook package and enable it in your project's manifest.

Ensure you meet all prerequisites, including the required UniTask dependency, to successfully enable Orderbook functionalities in your Unity project.

Orderbook package

💡Supported Platforms and Versions

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

📋Prerequisites

The UniTask package (v2.3.3) is a dependency of our SDK. Follow the instructions here to install it.

If you encounter any conflicts, refer to Unity’s guide on resolving package conflicts here.

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/Orderbook and click 'Add'

Via manifest.json

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

---

Related content

Fees

Learn about the different types of fees and how they are structured in the Immutable Orderbook.

Learn more

Order Statuses

Understand the different order statuses and what they mean using this reference table.

Learn more

Unity SDK Reference

Check out our full range of functionality in the complete Unity SDK Reference.

Learn more