Skip to content

Latest commit

 

History

History
103 lines (73 loc) · 5.42 KB

README.md

File metadata and controls

103 lines (73 loc) · 5.42 KB
Raw

📖 About

Essential hooks for modding with Fabric, now available on NeoForge!

Fabric API is the library for essential hooks and interoperability mechanisms for 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.

📘 The official documentation is available at sinytra.org.

The Forgified Fabric API (FFAPI) is a direct port of Fabric API for the NeoForge modloader, regularly kept up to date with the upstream repository. It is designed to make cross platform mod development easier by allowing developers to use Fabric API as a common library to interact with the game's code on both platforms. However, it is not an abstraction layer, and loader-specific code still needs to be handled separately for each platform.

💬 Join the Community

We have an official Discord community for our projects. By joining, you can:

  • Get help and technical support from our team and community members
  • Keep in touch with the latest development updates and community events
  • Engage in the project's development and collaborate with our team
  • ... and just hang out with the rest of our community.

Compatibility

The Forgified Fabric API has checks in place to ensure full api compatibility with Fabric API. This usually includes net.fabricmc.*.api packages and other non-internal code. However, we make no guarantees for implementation code and internal APIs, as they are subject to change at any time. For the best results, avoid using internal classes and look for native solutions offered by your platform.

Where possible, Fabric APIs such as FabricItem, ItemStorage and FluidStorage are bridged to NeoForge's counterparts. More information on how to properly consume bridged APIs can be found in their module's README.

Design Goals

Our goal is to port as much of Fabric API to use NeoForge's systems as possible and keep modifications to minecraft's code at minimum, in order to increase mod compatibility and reduce maintenance costs. On the other hand, it's important that using NeoForge's API doesn't come at the expense of preserving intended behavior.

📋 Using Forgified Fabric API to play with mods

Make sure you have installed NeoForge first. More information about installing NeoForge can be found here.

The Forgified Fabric API is available for download on the following platforms:

The downloaded jar file should be placed in your mods folder.

🛠️ Using Forgified Fabric API to develop mods

To set up a NeoForge development environment, please read the NeoForge docs and follow the instructions there.

The Forgified Fabric API is published under the org.sinytra.forgified-fabric-api group. To include the full Forgified Fabric API with all modules in the development environment, add the following to your dependencies block in the gradle buildscript:

Groovy DSL

repositories {
    maven {
        url "https://maven.su5ed.dev/releases"
    }
}
dependencies {
    implementation "org.sinytra.forgified-fabric-api:forgified-fabric-api:FABRIC_API_VERSION"
}

Instead of hardcoding version constants all over the build script, Gradle properties may be used to replace these constants. Properties are defined in the gradle.properties file at the root of a project. More information is available here.

Modules

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