Documentation

Appearance

Overview ​

Clearly the main focus of the Factory API is for developers, but that doesn't stop it from having some features for players as well.

Basic Concepts ​

Player Features ​

  • UI Definition | a way to change the interface with .json files in <namespace>:ui_definitions/ with just the use of resource packs
  • Manual Mipmapping | a way to use non-autogenerated textures for mipmap levels, either by using a default directory (configurable), or by specifying textures in a .mcmeta file on the block texture that will be mipmapped
  • Random Block Rotations | a toggle for the random block rotations, such as grass blocks and sand
  • Nearest Mipmap Scaling | a toggle for a slightly less demanding autogenerated-mipmapping mode, using a nearest texture scaling

Developer Features ​

  • UIAccessor | a unified way to access parts of the game's interface, without the need for any workarounds
  • FactoryConfig | an easy configuration system using the vanilla Codec, which has server/client synchronization capabilities, support for per-world configs, and a display control for creating a widget on the client-side
  • FactoryMixinToggle | an alternative to FactoryConfig to be used exclusively with mixin toggles, without using vanilla classes, which can be easily converted to the respective FactoryConfig classes
  • CommonNetwork | a unified way of registering and sending packets, with minimal changes between game versions
  • CommonRecipeManager | a unified way of accessing the recipes loaded, both on the server-side and on the client-side (synchronizing the recipes +1.21.2)
  • IFactoryStorage | an interface to expose the storages of a BlockEntity to mod loaders' accessors
  • FactoryStorage | a class for identifiers of the default implemented storages, used in IFactoryStorage.getStorage
  • IFactoryItem | an interface to expose the storages of an Item to mod loaders' accessors, and some other client features such block entity renderer and custom armor models
  • RegistryListing | a class to facilitate registration between mod loaders, also allowing the organization of holders between different listings
  • FactoryAPIPlatform | a class for numerous methods unified across mod loaders and game versions, from getting information about loaded mods to creating instances of RegistryListing
  • ItemContainerPlatform | a class focused on facilitating interaction with fluid and energy containers between mod loaders