Does LibrarianLib automatically generate models for my items and blocks?

Yes, LibrarianLib can auto-generate models for items and blocks that don't have custom models defined. This feature can be disabled if you want to use only custom models.

How do I use sprite sheets in my GUI instead of separate texture files?

LibrarianLib lets you define data-driven sprite sheets that keep your GUI code clean and organized. The sprite sheet guide shows how to set up and reference sprites in your GUI layouts.

Will LibrarianLib work with other library mods like Baubles or Mantle?

LibrarianLib is designed to coexist with other mods and doesn't conflict with standard library mods. If you encounter issues, check that you're using compatible versions for your Minecraft version.

Can I use LibrarianLib's shader system for custom visual effects?

Yes, LibrarianLib includes a shader system for adding custom visual effects. You'll need to write shader code and integrate it with your mod's rendering logic.

What happens if I mark a field with @Save but don't set up the mod correctly?

The field may not sync properly between client and server, causing desynchronization issues. Make sure to follow the setup requirements in the data syncing guide for your specific use case (tile entity, packet, etc.).

Does LibrarianLib handle item color registration automatically?

Yes, LibrarianLib automatically registers item colors and other model-related properties, reducing boilerplate code. You can still override this behavior if you need custom color logic.

Librarianlib Wiki & Guide — Wiki 9Minecraft

DownloadLibrarianlib

Get the files on 9Minecraft

Contents (6)

Overview
Version Differences
Guides
Frequently asked questions
Gallery
You May Also Like

Overview

LibrarianLib is a suite of libraries designed to streamline the modding process for Minecraft, specifically tailored for the mods created by Team Wizardry. It acts as a foundational layer that handles the complex "boilerplate" code required for modern modding, allowing developers to focus on creative content rather than technical minutiae.

While the library is primarily written in Kotlin, it is meticulously engineered to be fully compatible and easy to use within Java environments. It manages several critical aspects of modding, including:

Automated Registration: Simplifies the process of adding blocks, items, and entities to the game.
Networking (Courier): A robust packet-handling system.
UI Framework (Facade): A sophisticated system for creating complex Graphical User Interfaces (GUIs).
Rendering (Glint/Form): Advanced shader and model rendering utilities.

Version Differences

LibrarianLib has evolved significantly between Minecraft versions 1.12.2 and 1.17.1:

Feature	1.12.2 Status	1.17.1+ Status
Foundation	Core registration module	Removed (Integrated into Forge/Vanilla)
Courier	Deeply coupled with Forge	Lightly coupled, updated registration
Facade	Fully supported	Updated for modern rendering engines
Kotlin Support	Required as a dependency	Integrated/Bundled

Guides

Step-by-step, in-game.

Create a Custom GUI Without Magic NumbersUsing the Modular GUI System LibrarianLib's GUI library eliminates hardcoded pixel positions by breaking interfaces…Create and Manage Particle Effects at ScaleHigh-Performance Particle System LibrarianLib includes a particle engine optimized to render thousands of particles…Sync Custom Data Between Client and ServerAutomatic Field Synchronization LibrarianLib can automatically send tile entity and packet data across the network…Use Sprite Sheets for Clean GUI TexturesData-Driven Sprite Sheet System LibrarianLib lets you define sprite sheets declaratively, keeping texture coordinates…

Frequently asked questions

Do I need to do anything to install Librarianlib or does it just work?

LibrarianLib is a library mod that works automatically once installed—you don't need to configure it. Other mods that depend on LibrarianLib will use its features behind the scenes.

How do I sync data between my server and client?

Mark the fields you want to sync with the @Save annotation, and LibrarianLib will handle the network communication automatically. Check the guide on syncing custom data for setup details specific to tile entities or packets.

Can I use Librarianlib to make a custom GUI without hardcoding pixel positions?

Yes—LibrarianLib's GUI library uses a modular, constraint-based system that lets you build layouts without magic numbers. See the custom GUI guide for examples of positioning elements relative to each other.

What's the performance impact of using Librarianlib's particle system?

LibrarianLib's particle system is optimized to handle thousands of particles efficiently, so it should have minimal impact on most systems. If you're spawning massive numbers of particles, the guide on particle effects covers best practices.

See all 20 Librarianlib questions ›