Jauml

<p align="center"> <img src="https://raw.githubusercontent.com/Fuzss/modresources/main/pages/commons/headers/about.png" alt="About"> </p> <p align="center"> <img src="https://i.imgur.com/SUC5uIv.png" alt="Jauml Banner"> </p> <p align="center"> <a href="https://nightbeam.dev/support"> <img src="https://i.imgur.com/R9eqHGA.png" alt="Support me on Ko-fi" width="400"> </a> </p> <p align="center"> This beta release of Jauml lays a solid foundation for managing mod configurations in Minecraft. Whether you're adding new settings or validating existing ones, this library streamlines the process with clean, maintainable code. It’s an essential tool for mod developers looking to enhance their projects with flexible config options. </p> <p align="center"> <a href="https://discord.gg/TJc3CxR4jK"> <img src="https://img.shields.io/static/v1?label=&message=Discord&color=ECEBE6&labelColor=2F4858&style=for-the-badge&logo=discord&logoColor=white" alt="Discord"> </a> <a href="https://www.youtube.com/@nightbeamstudio"> <img src="https://img.shields.io/static/v1?label=&message=YouTube&color=ECEBE6&labelColor=2F4858&style=for-the-badge&logo=youtube&logoColor=white" alt="YouTube"> </a> <a href="https://github.com/MeherBenSalem"> <img src="https://img.shields.io/static/v1?label=&message=GitHub&color=ECEBE6&labelColor=2F4858&style=for-the-badge&logo=github&logoColor=white" alt="GitHub"> </a> <a href="https://www.curseforge.com/members/nightbeamstudio/projects"> <img src="https://img.shields.io/static/v1?label=&message=CurseForge&color=ECEBE6&labelColor=2F4858&style=for-the-badge&logo=curseforge&logoColor=white" alt="CurseForge"> </a> <a href="https://modrinth.com/organization/nightbeam"> <img src="https://img.shields.io/static/v1?label=&message=Modrinth&color=ECEBE6&labelColor=2F4858&style=for-the-badge&logo=modrinth&logoColor=white" alt="Modrinth"> </a> </p> # Usage for Developers Jauml is a **library dependency**. Players usually install it because another mod requires it. | Step |Action | | ------------------ |------------------------------------------------------------ | | Add dependency |Depend on Jauml from your Fabric / Forge / NeoForge build | | Create config |Define your settings with Jauml’s JSON config helpers | | Load on startup |Read and validate config when your mod initializes | | Save changes |Write updates back through the same config layer | | Ship with your mod |List Jauml as a required dependency on CurseForge / Modrinth | # Configuration Jauml itself is a library. **Your mod** owns the config files. Typical pattern: * Your mod declares settings through Jauml * JSON config files are generated / updated under the usual Minecraft config folder * Invalid or missing values can be validated and restored to safe defaults Example shape (illustrative): ``` { "enabled": true, "debug": false, "values": { "exampleOption": 1 } } ``` Exact keys depend on the mod using Jauml. # Compatibility * Singleplayer * Multiplayer / dedicated servers (as required by dependent mods) * Fabric * Forge * NeoForge * Large modpacks * Client + server (library; follow the dependent mod’s side requirements) # Community & Support * Discord: (https://discord.gg/TJc3CxR4jK) * GitHub: (https://github.com/MeherBenSalem/jauml) * Website: (https://nightbeam.dev/) * Store: (https://nightbeam.dev/store) * CurseForge: (https://www.curseforge.com/members/nightbeamstudio/projects) * Modrinth: (https://modrinth.com/organization/nightbeam) # License Jauml is licensed under the Apache License 2.0. You are free to use, modify, and redistribute Jauml in accordance with the terms of the Apache License 2.0. Feel free to include Jauml in modpacks. (https://i.imgur.com/xrZhnWD.png)](https://nightbeam.dev/community)