FramingLib

Framing Lib

A lightweight, client-sided configuration screen library for creating interactive, draggable HUD layout screens!

📖 What is this mod?

This is a client-side configuration screen library for creating draggable HUD layout screens.

It allows developers to create configuration screens with interactive, draggable elements to make positioning their HUD/GUI elements easier for the player.
This is not a complete configuration API, it is simply for creating configuration screens.

Basically, this is for other mods that rely on it to work.

Here are some visuals to help show what this does:

A more practical example, moving chat around:

✅ Features

• Multi-Loader Support: Fully compatible with Fabric, Quilt, Forge and NeoForge
• Intuitive for Players: Allows repositioning HUD/GUI elements by simply dragging them around with the mouse
• Developer-Friendly API: Uses a simple builder pattern, making integration easy for any HUD/GUI mod
• Dynamic Alignment: Anchors HUD/GUI elements to nine screen positions automatically, with optional snapping
• Smart Recalculation: Recalculates HUD/GUI locations when GUI scale or window size changes
• Lightweight & Performant: Caches and only recalculates positions when necessary to save frames
• Client-Side Only: Installed only on the client, no server-side footprint or installation required
• Extensively Customizable: Supports custom colors, icons, and even using your own custom rendering functions

⚠️ To remain flexible, this library does not automatically save or load layout data to the disk. Developers are responsible for serializing the layout object (into JSON/YAML/INI/your preferred config format) and deserializing it when the game initializes.

📖 Usage

📖 For Players

⚠️️ This is a library mod, and does nothing on its own.

Put the jar file in your mods folder and you're good to go!

For [Fabric] and [Quilt] version, you probably also need to put [ModMenu] in your mods folder.

📖 For Developers

Developer documentation can be accessed here

🚀 Supported Versions

✅ - Supported ⏳ - Planned ⏳ - Not supported

Notes:

• Latest mod version is written in parentheses