https://github.com/jahirxtrap/configlibtxf
A powerful & lightweight config library for Minecraft mods
https://github.com/jahirxtrap/configlibtxf
fabric forge java library minecraft neoforge
Last synced: about 1 month ago
JSON representation
A powerful & lightweight config library for Minecraft mods
- Host: GitHub
- URL: https://github.com/jahirxtrap/configlibtxf
- Owner: jahirxtrap
- License: mit
- Created: 2023-10-05T05:08:51.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2026-05-26T17:14:05.000Z (about 1 month ago)
- Last Synced: 2026-05-26T19:08:43.334Z (about 1 month ago)
- Topics: fabric, forge, java, library, minecraft, neoforge
- Language: Java
- Homepage: https://www.curseforge.com/minecraft/mc-mods/configlib-txf
- Size: 515 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
ConfigLib TXF mod
A powerful & lightweight config library for Minecraft mods
Main features:
Automatic Config Screen: A ready-to-use GUI with tabs, categories, and a reset button on every field
JSON5 Config Files: Human-friendly config files with auto-generated comments showing defaults, ranges, and allowed values
Rich Widgets: Toggles, sliders, cycle buttons, color picker, file/directory chooser, and item/block icon preview
Real-Time Editing: Changes apply instantly while editing, with per-field validation (min/max, regex) and visual feedback
Server Sync: Seamlessly syncs selected fields from server to clients in multiplayer, keeping gameplay consistent
Multiple Configs: Split a mod's settings across several files with an automatic hub screen for navigation
Full Translation Support: Every label, tooltip, tab, and enum value can be translated through the standard language files
Fabric/Quilt dependencies:
- Mod Menu mod (Optional)
### Dependency (Maven Central)
```groovy
repositories {
mavenCentral()
}
dependencies {
// Fabric
implementation 'io.github.jahirxtrap:configlibtxf:TAG-fabric'
// Forge
implementation 'io.github.jahirxtrap:configlibtxf:TAG-forge'
// NeoForge
implementation 'io.github.jahirxtrap:configlibtxf:TAG-neoforge'
}
```
Replace `TAG` with the version you want (e.g. `26.1.2-2.0.1`).
### Usage
```java
// initialize config
TXFConfig.init(MODID, ModConfig.class);
```