Overview#
FlytreLib is a core dependency mod required for the operation of Flytre7's suite of content. Rather than adding gameplay content like mobs or biomes directly, it serves as a foundational layer that consolidates repetitive code, networking protocols, and rendering utilities. This ensures that all dependent mods remain lightweight, compatible with one another, and easy to maintain across different Minecraft versions.
The library provides a robust set of APIs that handle complex tasks such as custom recipe registration, fluid management, and advanced Graphical User Interface (GUI) rendering. It is compatible with both the Forge and Fabric mod loaders for versions 1.18.2 and 1.19.2.
Core Mechanics & APIs#
FlytreLib introduces several advanced systems that dependent mods utilize to function. These mechanics are primarily focused on streamlining mod interactions and providing a unified user experience.
Config API
The library features a JSON-based configuration system that allows players and server owners to fine-tune mod settings. Key features include:
- Auto-Generation: Automatically creates default configuration files if they are missing.
- Hot-Reloading: Detects changes made to the config file on the disk and updates the game settings in real-time without requiring a restart.
- Corruption Protection: Backs up broken or corrupted config files with a timestamp before resetting them to safe defaults.
GUI & Rendering Utilities
FlytreLib provides a suite of tools for creating modern, transparent, and interactive menus. This includes:
- Cycling Buttons: Multi-state buttons that toggle through different settings.
- Transparent Sliders: Aesthetic UI elements for adjusting numerical values.
- Image-Based Buttons: Quick-implementation buttons that use custom textures for state changes.
- Render Utils: Simplified code for handling 3D model rendering, used extensively in mods like Flytre's Gun Mod.
NBT Pattern Matching
This system allows mods to look up and match items, blocks, or entities based on specific NBT data. It supports partial matching, meaning only the specified tags (such as enchantments or custom names) need to match while others are ignored.
Supported Mods#
FlytreLib is a mandatory requirement for the following modifications. Without this library, these mods will fail to initialize or may cause the game to crash.
| Mod Name | Description |
|---|---|
| Flytre's Gun Mod | Adds highly customizable 3D firearms and combat mechanics. |
| Flytre's Furniture | Introduces a wide variety of interactive and decorative furniture blocks. |
| Biome Locator | A tool for finding specific biomes and viewing detailed biome data. |
| Salutem | A health and wellness mod focused on survival mechanics. |
| Crazy Creepers | Enhances Creeper AI and adds new explosive variants. |
| Pipe | Provides advanced item and fluid transport piping systems. |
| Dual Riders | Allows two players to ride a single horse simultaneously. |
| Stat Check | Adds detailed tooltips for comparing tools, blocks, and food items. |
Commands & Keybinds#
The library adds specific commands and keyboard shortcuts to help manage the configuration of all Flytre7 mods in a unified way.
Commands
/reloadconfig: This command forces the server to reload all configuration files for mods using the FlytreLib Config API. This is essential for applying changes made to server-side settings without restarting the server instance.
Keybinds
- F3 + Y: A custom debug keybind that instantly reloads all client-side configurations. This is a faster alternative to the standard
F3 + T(which reloads all textures and resources).
Technical Specifications#
For advanced users and developers, FlytreLib includes several specialized APIs to handle game data:
- Recipe API: Simplifies the creation of custom crafting, smelting, and machine-specific recipes.
- Fluid API: A unified system for handling custom liquids, buckets, and tank interactions.
- Upgrade API: Provides a framework for adding modular upgrades to items or machines in content mods.
- Registry Helpers: Caches registry lookups for items, blocks, and entities to prevent performance drops during repeated calls.
Items, Blocks, and Mobs#
As a Library Mod, FlytreLib does not add any unique mobs, items, or blocks to the Minecraft world on its own. Its primary purpose is to provide the code that allows other mods to add these features.
If you are looking for specific items (like guns or furniture) or mobs (like new creeper types), ensure you have installed the corresponding content mod alongside FlytreLib. The library manages the registration and behavior of these elements but does not manifest them in the creative inventory or the game world independently.
