A lightweight, client-sided configuration screen library for creating interactive, draggable HUD layout screens!
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:
⚠️ 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.
⚠️️ 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.
Developer documentation can be accessed here
| Minecraft | Fabric | Quilt | Forge | NeoForge |
|---|---|---|---|---|
| 26.2 | ⏳ | ⏳ | ⏳ | ⏳ |
| 26.1.2 | ⏳ | ⏳ | ⏳ | ⏳ |
| 26.1.1 | ⏳ | ⏳ | ⏳ | ⏳ |
| 26.1 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.21.11 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.21.10 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.21.9 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.21.8 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.21.7 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.21.6 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.21.5 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.21.4 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.21.3 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.21.2 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.21.1 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.21 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.20.6 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.20.5 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.20.4 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.20.3 | ❌ | ❌ | ❌ | ❌ |
| 1.20.2 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.20.1 | ⏳ | ⏳ | ⏳ | ⏳ |
| 1.20 | ⏳ | ⏳ | ⏳ | ❌ |
| 1.19.4 | ✅(1.0.15) | ✅(1.0.15) | ✅(1.0.15) | ❌ |
| 1.19.3 | ✅(1.0.14) | ✅(1.0.14) | ✅(1.0.14) | ❌ |
| 1.19.2 | ✅(1.0.13) | ✅(1.0.13) | ✅(1.0.13) | ❌ |
| 1.19.1 | ✅(1.0.12) | ✅(1.0.12) | ✅(1.0.12) | ❌ |
| 1.19 | ✅(1.0.11) | ✅(1.0.11) | ✅(1.0.11) | ❌ |
| 1.18.2 | ✅(1.0.10) | ✅(1.0.10) | ✅(1.0.10) | ❌ |
| 1.18.1 | ✅(1.0.9) | ✅(1.0.9) | ✅(1.0.9) | ❌ |
| 1.18 | ✅(1.0.8) | ✅(1.0.8) | ✅(1.0.8) | ❌ |
| 1.17.1 | ✅(1.0.7) | ✅(1.0.7) | ✅(1.0.7) | ❌ |
| 1.17 | ❌ | ❌ | ❌ | ❌ |
| 1.16.5 | ✅(1.0.2) | ✅(1.0.2) | ✅(1.0.2) | ❌ |
✅ - Supported ⏳ - Planned ⏳ - Not supported
Notes:
