User Tools

Site Tools


tutorial:transfer-api

This is an old revision of the document!


[WIP] Understanding the Fabric Transfer API

This series of tutorials is meant to explain how the Fabric Transfer API works, and how you can use it for your own mods. Please make sure that you read all of these tutorials in order, even if you are only interested by item transfer. For any question, please go to the #transfer-api-debating channel on the official Fabric Discord server.

Introduction to the API: creating a simple fluid tank

The first tutorial Creating a simple tank walks you through how you can create a simple tank, and what FluidVariant is. Please read it before moving on to the next ones.

Interacting with fluid storages: an overview of ''Storage<FluidVariant>''

In the second tutorial Understanding Storage<FluidVariant> you learn what Storage<FluidVariant> is and how to use it.

Implementing fluid storages: an overview of the provided implementations

[Not yet written] This tutorial will provide an overview of the provided base implementations and how they can be used.

Interacting with item storages: how to query and use item storages

[Not yet written] This tutorial will explain how the item API is almost the same as the fluid API, and how wrappers around Inventory/PlayerInventory can be retrieved.

Implementing item storages: an overview of the provided implementations

[Not yet written] Same as the fluid tutorial, but will also explain SingleStackStorage and how to use Inventory/SidedInventory/InventoryProvider.

Fluid-containing items

[Not yet written] How to use and implement the fluid-containing item API.

tutorial/transfer-api.1643722372.txt.gz · Last modified: 2022/02/01 13:32 by technici4n