Fast Transfer Lib

A clean, simple and fast energy api for the Fabric ecosystem, with bidirectional compatibility with Tech Reborn Energy. Currently used by Industrial Revolution and Wireless Networks, with support from other mods as well.

FTL is based on the Fabric API Lookup module, with an experimental extension for item API support, currently an open Fabric API PR.

Installation

repositories {
    maven {
        name = "Technici4n"
        url = "https://raw.githubusercontent.com/Technici4n/Technici4n-maven/master/"
        content {
            includeGroup "net.fabricmc.fabric-api" // until PR # is merged
            includeGroup "dev.technici4n"
        }
    }
    maven {
        name = "BuildCraft"
        url = "https://mod-buildcraft.com/maven"
    }
}

dependencies {
    modApi include("dev.technici4n:FastTransferLib:${project.ftl_version}")
}

In gradle.properties:

# put latest version here, check the commits!
ftl_version=/* ... */

Usage

EnergyIo is the core interface of FTL. Instances are queried and exposed through the SIDED and ITEM lookups in EnergyApi.

To register simple energy-containing items with an energy capacity and maximum insertion/extraction rates, SimpleItemEnergyIo#getProvider can be used. There is no equivalent for simple blocks at the moment, but that can be added if requested.

EnergyMovement provides a helper function to transfer energy between two EnergyIo's. EnergyPreconditions provides a few checks to fail-fast in case of bad API usage.

License

This library is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.