Skip to content

Latest commit

 

History

History
72 lines (65 loc) · 6.53 KB

README.md

File metadata and controls

72 lines (65 loc) · 6.53 KB

Porting Lib

A collection of utilities for porting mods from Forge to Fabric.

Use

Porting Lib is split into modules. All modules are available on this maven:

maven { url = "https://mvn.devos.one/releases/" }

You can depend on Porting Lib like this once you add the maven:

modImplementation(include("io.github.fabricators_of_create.Porting-Lib:<module>:<version>"))

You can find the latest version on Modrinth. Just choose a version and use its version number.

Modules

Module Description
asm Utils for doing asm
accessors Accessor mixins aplenty
attributes Additional Entity Attributes; step height, gravity, swim speed
base Code that has not yet been split into modules
blocks Adds extra block extensions.
brewing A potion recipe api
client_events Useful client-side events
common Miscellaneous utilities for other modules
core Core functionality used across other modules
config A minimal port of forge's config api
chunk_loading Custom chunk loading api
data Additional data generation providers
entity Multipart entities, extra spawn data, removal listening
extensions Extensions to vanilla classes for additional functionality
fluids Api that provides additional fluid attributes for fluids
gametest Tools to make GameTest creation as easy as possible
gui_utils Adds additional utility classes and methods for screens and guis
items Adds extra item extensions
lazy_registration A implementation of forge's DeferredRegister system rewritten for fabric
level_events Provides common level events for mods.
loot A small library to modify mob loot
mixin_extensions More features for Mixins
model_builders Additional model builders for data generation
model_generators Forge model generators
model_loader Base loader for custom model types
model_materials Material data for use in rendering
models Model implementations, ModelData, RenderTypes
networking A Forge-like packet system
obj_loader Loading .obj models
recipe_book_categories Allows mods to add additional recipe book categories
registries Custom datapack registries and registry utils
tags Forge tags
tool_actions Utilities for tool interactions
transfer Storage implementations, client-side lookup, FluidStack, assorted transfer utilities
utility Miscellaneous utilities that are too niche for other modules

Contributing

See the contribution information.

Related APIs

Some APIs (some in-house) we've found to also be useful with porting mods.

Name Description
Forge Config API Port A port of the Forge config API to Fabric
Registrate Refabricated A port of Registrate to Fabric
Reach Entity Attributes Provides Entity Attributes for reach distance
Milk Lib Provides a Milk fluid as well as other milk items used often by mods
Cardinal Components API Provides Components, which can replace Capabilities
Trinkets Accessories, replacing Curios
Here be no Dragons Hides the Experimental World Settings screen
Fabric ASM For when Mixin Extras just isn't enough