Skip to content
Kyle Gunger edited this page Jun 20, 2021 · 4 revisions

Welcome to the TransitAPI wiki!

Transit (aka TransitAPI) is a simple library for Minecraft mods which acts as a conversion layer for all sorts of things.

Transit provides the following:

  • A "Type" class made for representing your mod's <energy, fluid, item> transport stack.
  • A set of functions within the type which allow for easy conversion between types using the same objects.
  • A type registry for easy searching.
  • Some pre-defined registries: ENERGY, FLUID, ITEM, and MANA
  • Some pre-defined types: TFluid, TItem, TMana
  • "Pools" to represent different separated reserviours of information/transport stacks
  • ...And more!

The rest of the wiki will explain how to use and implement basic type conversion and pipe systems based on transit.

What transit does not do:

Transit is a small library, and it makes no assumptions on how you wish to transport these quantities internally, only about how quantities are exchanged between mods. Indeed, you can implement transit very lightly without touching such classes as "ISystem" or "AbstractProviderNode". As long as your pipes/machines/whatever use the "INode" interface, any other mod using this library will be able to communicate with yours.

On the other hand, a full-scale implementation using all of transit may wish to internally use an "ISystem" or such for the transport within the mod. Feel free to do so.

Happy modding,

-Kyle

Clone this wiki locally