OR-LIB – Library for Rendering Wearable Items (Fabric)

OR-LIB is a small Fabric library designed to simplify and standardize working with wearable gear (rings, amulets, trinkets, etc.) and its rendering in both first and third person. It was created so that multiple mods in a single pack can use it effortlessly, eliminating the need to rewrite the same code for poses, transformations, and specialized slots each time.

Main Purpose

• Provide a clear set of tools for creating wearable items with unique properties.
• Centralize the logic for registration, rendering, and transformation of such items.
• Offer seamless integration with third-party slot systems (similar to Trinkets) without imposing specific architectural solutions on mods.

Requirements

• Mod loader: Fabric.
• Trinkets mod (recommended for full functionality).

The library is particularly useful when paired with content mods that add jewelry, charms, or other wearable items to the game.

Important Note

The project is still in active development, so some features may not work exactly as expected.

Key Features

• Wearable Items API – ready-to-use classes and interfaces for creating WearableItem, defining WearableType, and setting related properties, with support for builder-style configuration of attributes, bonuses, and behavior.
• Centralized Registries – a system of WearablesRegistry and WearableContentRegistry for unified content storage, along with helper tags and classes for easy integration.
• Advanced Rendering System – simple out-of-the-box rendering with SimpleWearableRenderer for basic cases, and a flexible system for poses and transformations using SlotTransform, BodyAnchor, WearablePoseContext, and other components, including first-person model synchronization (FirstPersonWearableRenderer).
• Integrations and Hooks – client-side integrations for model loading and rendering items on the player, along with centralized rendering initialization via WearableRenderingBootstrap.
• Slot Compatibility – utilities for simplified interaction with various slot systems akin to Trinkets, allowing developers to focus on functionality and visual appearance rather than repetitive code.

For Mod Developers

1. Add OR-LIB as a dependency in your project.
2. Create your wearable item by extending or implementing the provided base classes (e.g., WearableItem) and configuring it via the builder.
3. Register the item in the library's registries.
4. If needed, attach a custom renderer through the client API for advanced graphics.
5. Utilize OR-LIB utilities for working with additional slot systems instead of writing your own integration code.

Architecture and Extensibility

OR-LIB is a foundational layer aimed at simplifying work with wearable equipment in the Fabric environment. It does not add content by itself but provides only a powerful API, registries, helper utilities, and a rendering system.