LibX Mod Wiki

LibX is an essential utility and library mod designed to streamline the development process for Minecraft mods, particularly those created by MelanX and the ModdingX team (such as UtilitiX, Botanical Machinery, and MythicBotany). While it is primarily a developer tool, it provides several high-level systems that ensure stability and performance across all dependent mods. For players, LibX acts as a silent engine that manages complex data-driven features, though it does include a suite of powerful diagnostic commands for advanced users and modpack creators.

As a library, LibX does not add new mobs, biomes, or dimensions directly to the game. Instead, it provides the underlying logic for other mods to implement these features efficiently. It is required for any mod that utilizes the LibX framework to function correctly in versions 1.20.1, 1.21.1, and beyond.

LibX includes a set of administrative and diagnostic commands accessible via the /libx prefix. These are particularly useful for debugging item data, block states, and entity NBT without needing external editors.

These commands output information directly to the chat, which can then be copied to the clipboard for use in modding or modpack configuration.

LibX features a custom, annotation-based configuration system that uses the JSON5 format. This allows for comments within configuration files, making them much easier for players and modpack authors to navigate and edit.

Config Types

• Common Configs: These are shared between the client and the server. When a player joins a server, the server's common config values are synced to the client to ensure gameplay consistency.
• Client Configs: These are local to the player's machine and handle visual or audio settings that do not affect server-side logic.

File Locations

Configuration files generated by LibX are typically found in the .minecraft/config/ directory. They follow a specific naming convention based on the mod ID:

• config/modid.json5 (Primary config)
• config/namespace/path.json5 (Sub-configs or categorized settings)

Features

• Automatic Syncing: Ensures that players cannot bypass server rules by changing local config files.
• Validation: Includes built-in validators like @IntRange to prevent invalid values (e.g., setting a spawn rate to a negative number) from crashing the game.

The strength of LibX lies in its automated systems that handle the heavy lifting of mod development. These systems ensure that all dependent mods follow a standardized logic.

Registration System

LibX automates the registration of game objects (Items, Blocks, Tile Entities, etc.). It uses a "Registry Transformer" system that can automatically generate associated items for blocks (like BlockItems) or handle complex multi-block registrations in a single step.

Datagen System

To ensure compatibility and reduce errors, LibX provides a comprehensive Data Generation (Datagen) suite. This system is used by developers to automatically create:

• Recipes: Standardizes crafting, smelting, and custom machine recipes.
• Loot Tables: Manages drops for blocks and mobs.
• Tags: Ensures cross-mod compatibility for materials like ores and ingots.
• Models and Textures: Automates the creation of JSON model files for items and blocks.

LibX includes a specialized sub-library known as SandBox. This component is dedicated to world generation and provides tools for other mods to create custom dimensions and structures.

• Surface Rules: Simplifies the creation of complex terrain patterns and biome-specific surface layers.
• Structure Placement: Provides more control over how and where structures (like dungeons or villages) spawn in the world.
• Dimension Logic: Handles the registration and management of custom dimensions, ensuring they integrate smoothly with the vanilla teleportation and chunk loading systems.

LibX implements several advanced technical mechanics to improve the modding environment:

• Networking Wrapper: A simplified networking layer that allows mods to send data packets between the client and server with minimal overhead.
• Base Classes: Provides pre-optimized base classes for common objects like BlockBase, ItemBase, and MenuBase, which include built-in support for tooltips, creative tab placement, and specialized rendering.
• Render Types: Includes helpers for managing transparency and custom shaders, often used in mods that add magical effects or complex machinery.