Setup
How to build a config for your Minecraft mod with TabbyLib.
All code examples in these docs are free to use: copy them into your own projects and change them as you like, no credit needed.
Requirements
| TabbyLib | 2.0.1 |
|---|---|
| Minecraft | 26.3 |
| Fabric | Fabric Loader 0.19.5 or newer, with Fabric API |
| NeoForge | 26.3.0.101 or newer |
| Java | 25 |
| Side | Client only |
Gradle
Add the TabbyLib maven repository and the dependency for your loader to your build.gradle:
repositories {
maven { url = "https://avie.cc/maven" }
}
dependencies {
// Fabric (Loom)
implementation "cc.avie.tabbylib:tabbylib:2.0.1"
// NeoForge (ModDevGradle)
implementation "cc.avie.tabbylib:tabbylib-neoforge:2.0.1"
}
The API is the same on both loaders. For a multiloader project, the shared code only needs the loader independent jar:
// common project
dependencies {
compileOnly "cc.avie.tabbylib:tabbylib-common:2.0.1"
}
fabric.mod.json
Add TabbyLib as a dependency of your mod, so players get a message when it is missing:
"depends": {
"tabbylib": ">=2.0.1"
}
neoforge.mods.toml
On NeoForge the same goes into META-INF/neoforge.mods.toml:
[[dependencies.my_mod]]
modId = "tabbylib"
type = "required"
versionRange = "[2.0.1,)"
ordering = "NONE"
side = "CLIENT"
That's it. Players find the settings of every mod that uses TabbyLib behind the Tabby Config button in the options menu, with /tabbylib and behind the config button of your mod in the mod list – on Fabric when Mod Menu is installed, on NeoForge always.