Unity Orderbook (Alpha)
In this section you’ll find everything you need to know about interacting with the Immutable Orderbook in your Unity game.
What is the Unity Orderbook?
The Immutable Unity Orderbook package enables seamless on-chain trading directly within your game. It provides in-game access to the Immutable Orderbook, a global marketplace where users can buy and sell digital assets, such as NFTs.
The Unity Orderbook package allows developers to create, fill, and cancel orders, eliminating the need to redirect gamers to external marketplaces in their web browser.
For more information on the Orderbook itself see the Orderbook documentation.
Why use the Unity Orderbook?
For players, leaving the game to buy or sell assets can be a jarring experience which breaks the flow of the game loop. The Unity Orderbook package allows developers to create a seamless experience for players by enabling them to buy and sell assets directly within the game. This leads to a more enjoyable experience for players and can help to increase player retention and engagement.
- Enforceable Fees: Orderbook allows the attachment of fees to orders at their origin, ensuring they persist throughout the entire Immutable ecosystem.
- Marketplace Infrastructure: New in-game marketplaces can be easily bootstrapped, allowing custom marketplace experiences to be built directly for your game.
- Increased Revenue: By sharing NFT orders across marketplaces, Orderbook helps increase revenue and liquidity for marketplaces, studios, and creators.
- Seamless Integration: When integrated with the Unity Passport package, developers can create, fill, and cancel orders, enabling gamers to buy and sell digital assets effortlessly within the game environment.
Limitations
The core functionality required to create a marketplace is available through the Unity Orderbook package, however not all features from the TypeScript Orderbook are available yet. The Unity Orderbook is limited to creating orders - listings, filling orders and cancelling orders.
The Unity version closely follows the TypeScript documentation and we are working to add more features in the future.
What's in the “Unity Orderbook” section?
This section covers the setup and implementation details of each of the available methods in the Unity Orderbook package.
Audience: Game Developers| Feature | Description |
|---|---|
| Create order ‑ listings | Effortlessly list an NFT for sale at a fixed price directly from your inventory screen, enabling seamless transactions within the game. |
| Fill orders | Purchase an NFT at the listed price directly within the in-game marketplace, allowing gamers to enhance their collection without leaving the game. |
| Cancel orders | Easily cancel an active order within the game, providing gamers with flexibility and control over their listings. |
| Get token balance | Retrieve the player's in-game currency balance to ensure they have sufficient funds for purchases. |
How do I use the “Unity Orderbook” section?
If this is your first time using the Unity Orderbook package, we recommend starting with the Setup instructions. This will walk you through the process of setting up the Unity Orderbook package in your game. Otherwise simply click on the page for the feature you're interested in to get started.