Wiki 9Minecraft Wiki 9Minecraft

Librarianlib FAQ

20 questions players actually ask, answered.

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.
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.
What does Librarianlib do?
It is a client-side rendering and animation library that provides shared visual and utility code for mods. It does not add blocks , items, or gameplay content.
What is Librarianlib?
LibrarianLib is a library mod for modders, offering an extensive collection of tools, utilities, and frameworks. Its features include GUI, particle, shader, serialization, networking, and sprite sheet systems.
Does Librarianlib add new items or blocks?
No. It is a library mod that provides shared visual and utility code rather than adding blocks , items, or gameplay content.
What Minecraft versions does Librarianlib support?
The mod file lists Minecraft 1.21.1 and above, while the project page also lists 1.17.1 and 1.21.1.
What mod loaders does Librarianlib support?
The mod file lists NeoForge, while the project page lists both Fabric and NeoForge.
What are the main features of Librarianlib?
Its features include Facade (a GUI framework ), Glitter (high-performance particle systems), Albedo (shader infrastructure), Scribe (automatic serialization), Courier (networking helper), and Mosaic (data-driven sprite sheets).
Does Librarianlib have a GUI library?
Yes. It includes Facade, a powerful and flexible GUI framework , as well as a GUI library that allows easy construction and design of GUIs.
Does Librarianlib have a particle system?
Yes. It includes Glitter, a high-performance particle system that can handle tens of thousands of particles at once.
Does Librarianlib have a shader system?
Yes. It provides Albedo, non-opinionated shader infrastructure with custom vertex layouts and type-safe APIs.
Does Librarianlib have networking support?
Yes. It includes Courier, an easy-to-use networking helper that uses Scribe.