SuperMartijn642's Config Lib
- ⬇ 34.2M downloads (as reported by Modrinth)
- ♥ 1.3K followers
- License: LicenseRef-All-Rights-Reserved
- Updated:
- Loaders: fabric, forge, neoforge, quilt
SuperMartijn642's Config Lib allows you to specify a config once and it then handles reloading values between world loads, syncing values with clients, and generating values for client- or server-only on its own.
---
Creating a config:
A config is created using a ModConfigBuilder.
Simply create a new instance using #ModConfigBuilder().
A value can be added to the config with ModConfigBuilder#define which takes a name and a default value.
For integer and double values a minimum and maximum value are also required.
ModConfigBuilder#define returns a Supplier which should be stored to retrieve the value from the config.
A comment can be added to a value by calling ModConfigBuilder#comment(String) before defining the value.
By default values are reloaded when world is loaded.
This can be changed to only reload a value when Minecraft launches by calling ModConfigBuilder#gameRestart() before defining the value.
Values in COMMON or SERVER configs are synchronized with clients by default, to prevent this use ModConfigBuilder#dontSync().
Values can also be put into categories.
ModConfigBuilder#push(String) pushes a category and ModConfigBuilder#pop() pops a category.
A comment can be added to the active category using ModConfigBuilder#categoryComment(String).
After defining all values ModConfigBuilder#build() must be called to finish the config.
Now the values in your config will reloaded and synced automatically and the values can be retrieved using the stored Supplier instances.
This will work for all available versions, that includes Minecraft 1.12, 1.14, 1.15, 1.16, 1.17, 1.18, and 1.19.
---
Example Mod:
For a concrete example of how to use Config Lib checkout the example mod.
---
FAQ
Can I use your mod in my modpack?
Yes, feel free to use my mod in your modpack
---
Discord
For future content, upcoming mods, and discussion, feel free to join the SuperMartijn642 discord server!
<img width='400' src='https://imgur.com/IG1us6p.png'
Minecraft Mods
Discover and download top Minecraft mods across Modrinth and CurseForge. Filter by Fabric, Forge, NeoForge, and Quilt with automated dependency detection and pack export.
Arata Inlooker · Socials & Direct Contact
Direct Messages & Inquiries Accepted • Official Verified Channels