Forge Config API Port — Minecraft Java Edition

Vanilla Minecraft does not contain built-in tools for convenient configuration of game parameters or modifications, forcing developers to create configuration saving systems on their own. The Forge mod loader offers a ready-made solution in the form of its own configuration system, but Fabric historically does not have a single standard for this. Because of this, creators of cross-platform mods have to write separate configuration code for each loader, spending a lot of time on routine. The Forge Config API Port library solves this problem by porting Forge's time-tested configuration interface to Fabric and Quilt.

How the library works

Forge Config API Port acts as an intermediary between the modification code and the game's file system. It fully recreates the original packages net.minecraftforge.common.ForgeConfigSpec and net.neoforged.fml.config in the Fabric environment. A developer writes a configuration description only once using the standard Forge syntax, and the library automatically creates the corresponding files on disk and manages their loading.

TOML configuration file format

The library stores all settings in TOML format. This format offers a convenient structure for reading and editing using a regular text editor. Each parameter can contain comments, default values, as well as clear limits of acceptable values (minimum and maximum number). Configuration files automatically appear in the config folder inside the game's root directory after the first launch of the modification. They have the .toml extension and the name specified by the mod developer.

Automatic synchronization and dynamic reloading

One of the most important features of Forge Config API Port is the built-in support for synchronization and dynamic reloading of configurations:

• Synchronization between server and client (Sync): when a player connects to the server, the server automatically sends its settings to the client. This prevents conflicts due to different versions of configurations among players on the server.

• Dynamic reloading (Reload): the library monitors changes in TOML files in real time. If you edit and save the configuration file during the game, Forge Config API Port will immediately update the parameters in RAM without needing to restart the Minecraft client.

These mechanisms work automatically, freeing developers from having to code network interaction on their own to synchronize configuration values.

Value for players and developers

For regular players, Forge Config API Port does not add any visible content, new blocks, or items. Its role is to ensure the operation of other modifications. Without installing this library, the game simply will not start if other mods reference its classes. The modification is mostly needed by Fabric users, since Forge and NeoForge have these functions by default in their structure.

For developers, the library is an indispensable tool when creating cross-platform projects. It allows you to:

1. Save hundreds of lines of code that previously went into developing separate settings saving logic for different loaders.

2. Ensure the same mod administration experience for end users, since configuration files have an identical structure on Fabric and Forge.

3. Use the powerful Forge value validation toolkit, which automatically corrects erroneous user inputs, returning parameters to default values in case of failures.

Popular dependent modifications

The developer of the library, known under the nickname Fuzs (or Fuzs_), uses it in all of his popular mods. Here are a few well-known examples:

• Easy Magic: a mod that changes the mechanics of the enchanting table, allowing items to be stored inside the table's inventory and adding new ways to improve enchantments.

• Trading Post: a block that combines the trade offers of all surrounding villagers in a single interface.

• Visuality: a visual effects mod that adds realistic dirt particles, sparks, and water splashes from various mob actions.

• Easy Shulker Boxes: allows interacting with shulker boxes directly from the inventory without placing them on the ground.

Apart from projects by Fuzs, hundreds of other developers use Forge Config API Port to port their work from Forge to Fabric, giving players access to a huge library of quality content.