Overview#
Fireplace Lib is a core library mod designed to centralize common functionality used across the various projects created by The_Fireplace. By consolidating shared code into a single mod, it ensures easier maintenance, faster updates, and a lower risk of bugs across the entire mod ecosystem.
While Fireplace Lib does not add player-facing content like mobs or blocks on its own, it is a mandatory requirement for several popular mods. It provides the underlying architecture for multithreading, data serialization, and advanced configuration systems that allow other mods to function efficiently.
Core Mechanics & Features#
Fireplace Lib introduces several technical frameworks that optimize how mods interact with the Minecraft engine and the server-client relationship.
Multithreading
The library enables multithreading capabilities for dependent mods. This allows complex calculations—such as pathfinding for skeleton armies in the Overlord mod or economy processing in Grand Economy—to occur on separate threads, preventing server lag and maintaining a high TPS (Ticks Per Second).
Serialization and Deserialization
Fireplace Lib simplifies the process of saving and loading data. It provides a robust framework for converting Java objects into JSON format and vice versa. This is primarily used for:
- Config Files: Generating and reading user settings.
- Player Data: Saving mod-specific player progress or statistics.
- World Data: Storing information about custom structures or land claims.
Translation Management
One of the unique features of this library is its advanced translation management. It is specifically designed for "client-side-optional" mods. This means that if a server uses a mod that requires Fireplace Lib, a player can join without having that mod installed. If the player does choose to install it, Fireplace Lib ensures they can see the mod's content in their own language, regardless of the server's default language settings.
Lazy Configuration
The library utilizes a "Lazy Configuration" system. Instead of loading every possible configuration value into memory during the initial Minecraft startup, values are only loaded and calculated the first time they are actually needed by the game. This reduces memory overhead and speeds up the game's loading time.
Configuration & Commands#
Fireplace Lib provides a standardized configuration system that dependent mods use to create user-friendly settings files.
Configuration Files
When mods using Fireplace Lib are installed, they typically generate configuration files in the .minecraft/config/ directory. These files are often named after the specific mod (e.g., overlord.json) but utilize the Fireplace Lib backend for syncing.
| Feature | Description |
|---|---|
| Syncing | Server-side configurations are automatically synced to the client upon joining a world. |
| GUI Support | Compatible with Cloth Config to provide in-game configuration menus. |
| Format | All files use the standard JSON format for easy manual editing. |
Commands
While Fireplace Lib is primarily a backend tool, it provides a common command registration system. This ensures that commands added by dependent mods (like /overlord or /economy) follow a consistent syntax and permission structure across different Minecraft versions.
Integration & Dependencies#
Fireplace Lib acts as the foundation for a wide array of mods. To function correctly, Fireplace Lib itself requires the Annotated DI mod to be installed.
Mods Requiring Fireplace Lib
If you intend to use any of the following mods, Fireplace Lib must be present in your mods folder:
- Overlord: Allows players to raise and command an army of skeletons.
- Grand Economy: A server-side economy API for managing currency and trade.
- Unforgiving Void: Customizes player behavior when falling into the void (e.g., teleporting to other dimensions).
- Textbook: Enables the importing and exporting of text for Minecraft books.
- Clans: A land protection and PVP management system.
- Home Camp: Adds mechanics for setting spawn points and managing campsites.
- Mob Rebirth: Controls how and when mobs respawn after death.
- Fire's Survival Tweaks: A collection of small adjustments to enhance the survival experience.
Compatibility
Fireplace Lib is designed to be highly compatible with both Forge and Fabric/Quilt loaders, ensuring that the core logic of The_Fireplace's mods remains consistent regardless of the platform.
Items, Blocks, and Mobs#
As a technical library, Fireplace Lib does not add any items, blocks, or mobs to the game directly. It provides the code necessary for other mods to add these features. For example, while Fireplace Lib contains the code for skeleton behavior, the actual Skeleton Warriors are added by the Overlord mod.
Users looking for new gameplay content should install the dependent mods listed in the Integration section.
