Fabric Loader 26.1.2

The lightweight mod loader that powers the Fabric project.

Fabric Loader is Fabric's lightweight mod loader. It provides the necessary tools to make any version of Minecraft. On the other hand, game-specific and version-specific hooks belong in Fabric API.

INFO

While Fabric Loader is primarily used for Minecraft, it is possible to create a game provider for other Java applications (for instance games like Slay the Spire or Hytale).

Fabric Loader has services that allow mods to execute code during initialization, transform classes, declare and provide mod dependencies, all that in various environments.

The Javadocs for the latest version of Fabric Loader can be found on the Develop site.

The current instance of Fabric Loader can be retrieved by using FabricLoader.getInstance(). As an example, FabricLoader.getInstance().isModLoaded can be used to check whether another mod is running.

Mods

A mod is a jar with a fabric.mod.json metadata file in its root declaring how it should be loaded. That file contains a mod ID and version number, as well as entrypoints and mixin configurations.

The mod ID identifies the mod, and any two mods with the same ID are considered to be the same mod. Only one version of a mod may be loaded at a time.

A mod may also declare which other mods it depends on or conflicts with. Fabric Loader will attempt to satisfy dependencies and load the appropriate versions of mods; if it cannot it will fail to launch the game.

Fabric Loader makes all mods equally capable of modifying the game. As an example, anything Fabric API does can be done by any other mod.

Mods are loaded both from the classpath and from the mods directory. This directory can be changed with the fabric.modsFolder system property.

Nested JARs

INFO

Using Fabric Loom's include option will automatically handle nesting the JAR, including the generation of a fabric.mod.json for non-mod JARs.

Nested JARs allow a mod to provide its own dependencies, so Fabric Loader can find the best version while attempting to satisfy dependencies, instead of requiring them to be installed separately.

Nested JARs act like any other mod, with their own metadata file, but are contained within the parent JAR. Note that nested mods may themselves embed other children in the same way.

Nested JARs are extracted to the disk when the game is run. Paths to nested JARs must be declared relative to their containing JAR's root.

Entrypoints

Fabric Loader adopts an entrypoint-based system, which is used to expose certain code to Fabric Loader for initialization, or to other mods.

Initializers are loaded and called early during the game's boot, and this allows a mod to make its modifications with code. These entrypoints are typically used to bootstrap mods by registering registry objects, event listeners, and other callbacks for later actions.

Mixin

Mixins allow mods to transform Minecraft classes, and even other mods' classes, and they are the only type of class transformation that Fabric Loader officially supports. A mod can declare its own mixin configuration, which enables the use of Mixin.

Fabric Loader uses a modified fork of the original Sponge Mixin. However, the upstream Mixin wiki is still mostly valid.

Among Fabric's modifications there are: allowing all default injection points inside constructors, optimizing out unused callback infos, providing fixes for backwards compatibility, fixing static shadows, allowing injectors in interfaces, and more.

Mappings

INFO

Mappings are only relevant when using Fabric Loader on obfuscated games, including pre-26.1 versions of Minecraft.

Fabric Loader provides the MappingResolver API to determine names of classes, fields and methods with respect to the different environments that mods may be loaded in. This can be used to support reflection in any environment provided Fabric Loader has access to mappings to resolve the name.

FabricLoader.getInstance().getMappingResolver().mapClassName("intermediary", "net.minecraft.class_5421") // Resolves to `RecipeBookType` on named versions of 1.21.11

When launched in a non-development environment on an obfuscated game, Fabric Loader will remap the game jar(s) to intermediary names. Mods designed for obfuscated games are expected to be mapped to intermediary, which will be compatible with this environment. The remapped jars are cached and saved in ${gameDir}/.fabric/remappedJars/${minecraftVersion} for re-use across launches.