Essential hooks for modding with Fabric.
Fabric API is the library for essential hooks and interoperability mechanisms for Fabric mods. Examples include:
- Exposing functionality that is useful but difficult to access for many mods such as particles, biomes and dimensions
- Adding events, hooks and APIs to improve interopability between mods.
- Essential features such as registry synchronization and adding information to crash reports.
- An advanced rendering API designed for compatibility with optimization mods and graphics overhaul mods.
Missing -> Added -> Tested
| API | State | Lifecycle |
|---|---|---|
| fabric-api-base | ✅ Tested | Stable |
| fabric-api-lookup-api-v1 | ✅ Tested | Stable |
| fabric-biome-api-v1 | Experimental | |
| fabric-block-api-v1 | ✅ Tested | Stable |
| fabric-blockrenderlayer-v1 | ✅ Tested | Stable |
| fabric-client-tags-api-v1 | Stable | |
| fabric-command-api-v2 | ✅ Tested | Stable |
| fabric-content-registries-v0 | ✅ Tested | Stable |
| fabric-convention-tags-v1 | Stable | |
| fabric-crash-report-info-v1 | 🚧 Not Planned [1] | Stable |
| fabric-data-generation-api-v1 | Stable | |
| fabric-dimensions-v1 | ✅ Tested | Stable |
| fabric-entity-events-v1 | ✅ Tested | Stable |
| fabric-events-interaction-v0 | ✅ Tested | Stable |
| fabric-game-rule-api-v1 | ✅ Tested | Stable |
| fabric-gametest-api-v1 | Stable | |
| fabric-item-api-v1 | ✅ Tested | Stable |
| fabric-item-group-api-v1 | ✅ Tested | Stable |
| fabric-key-binding-api-v1 | ✅ Tested | Stable |
| fabric-lifecycle-events-v1 | ✅ Tested | Stable |
| fabric-loot-api-v2 | ✅ Tested | Stable |
| fabric-message-api-v1 | ✅ Tested | Experimental |
| fabric-mining-level-api-v1 | ✅ Tested | Stable |
| fabric-models-v0 | Stable | |
| fabric-networking-api-v1 | ✅ Tested | Stable |
| fabric-object-builder-api-v1 | ✅ Tested | Stable |
| fabric-particles-v1 | ✅ Tested | Stable |
| fabric-recipe-api-v1 | ✅ Tested | Stable |
| fabric-registry-sync-v0 | Stable | |
| fabric-renderer-api-v1 | Stable | |
| fabric-renderer-indigo | Stable | |
| fabric-rendering-data-attachment-v1 | Stable | |
| fabric-rendering-fluids-v1 | Stable | |
| fabric-rendering-v1 | ✅ Tested | Stable |
| fabric-resource-conditions-api-v1 | ✅ Tested | Experimental |
| fabric-resource-loader-v0 | Stable | |
| fabric-screen-api-v1 | ✅ Tested | Stable |
| fabric-screen-handler-api-v1 | ✅ Tested | Stable |
| fabric-sound-api-v1 | ✅ Tested | Stable |
| fabric-transfer-api-v1 | Experimental | |
| fabric-transitive-access-wideners-v1 | Stable | |
| fabric-command-api-v1 | Deprecated | |
| fabric-commands-v0 | Deprecated | |
| fabric-containers-v0 | Deprecated | |
| fabric-events-lifecycle-v0 | Deprecated | |
| fabric-keybindings-v0 | Deprecated | |
| fabric-loot-tables-v1 | Deprecated | |
| fabric-networking-v0 | Deprecated | |
| fabric-renderer-registries-v1 | Deprecated | |
| fabric-rendering-v0 | Deprecated |
[1] Does not provide an API, features already implemented by FML.
Fabric API is designed to be modular for ease of updating. This also has the advantage of splitting up the codebase into smaller chunks.
Each module contains its own README.md* explaining the module's purpose and additional info on using the module.
* The README for each module is being worked on; not every module has a README at the moment