Welcome, Mod Dev! Let's get your Fzzy Config system up and running. Guides in this wiki will cover two basic cases: _Minimal Effort_ and _Above and Beyond_. Feel free to take whatever route suits your needs!
## Starting Fresh
Creating a new mod and using Fzzy Config from the start? Thank you for choosing Fzzy Config! Take a trip to the New Configs guide for the step-by-step processes.
[New Configs](docs/config-design/New-Configs)
## Switching from Another Library
Making the leap from another config lib to this one? Welcome aboard! Check out the Existing Configs guide for the steps you'll need to integrate your existing system into Fzzy Configs.
[Existing Configs](docs/config-design/Existing-Configs)
## Depending on Fzzy Config
Add the following to your build script to depend on Fzzy Config:
#### Repositories:
```kotlin !!tabs build.gradle.kts
//version 0.4.3 or higher:
maven {
name = "FzzyMaven"
url = uri("https://maven.fzzyhmstrs.me/")
}
//version 0.4.2 or lower:
maven {
name = "Modrinth"
url = uri("https://api.modrinth.com/maven")
content {
includeGroup("maven.modrinth")
}
}
//for (neo)forge
maven {
url = URI("https://thedarkcolour.github.io/KotlinForForge/")
}
```
``` groovy !!tabs build.gradle
//version 0.4.3 or higher
maven {
name = "FzzyMaven"
url = "https://maven.fzzyhmstrs.me/"
}
//version 0.4.2 or lower
maven {
name = "Modrinth"
url = "https://api.modrinth.com/maven"
content {
includeGroup "maven.modrinth"
}
}
//for (neo)forge
maven {
url = "https://thedarkcolour.github.io/KotlinForForge/"
}
```
#### Dependencies:
Version names will be in the form `x.x.x+[mc_version]`, e.g. `0.4.3+1.21`. For (Neo)Forge builds, add `+neoforge` for 1.20.4+ and `+forge` for 1.20.1.
Either CurseForge 🗗, Modrinth 🗗, or the Maven itself 🗗 can be used to see the current version listings.
```kotlin !!tabs build.gradle.kts
//version 0.4.3 or higher
val fzzyConfigVersion: String by project //define this in your gradle.properties file
modImplementation("me.fzzyhmstrs:fzzy_config:$fzzyConfigVersion") //NOTE: underscore, not hyphen!
//version 0.4.2 or lower
val fzzyConfigVersion: String by project //define this in your gradle.properties file
modImplementation("maven.modrinth:fzzy-config:$fzzyConfigVersion")
```
```groovy !!tabs build.gradle
//version 0.4.3 or higher
modImplementation "me.fzzyhmstrs:fzzy_config:${project.fzzyConfigVersion}" //NOTE: underscore, not hyphen!
//version 0.4.2 or lower
modImplementation "maven.modrinth:fzzy-config:${project.fzzyConfigVersion}"
```
include or other jar-in-jar mechanisms are not allowed in the terms of the TDL-M License 🗗 that Fzzy Config is released under
## Documentation
Check out the projects API documentation for detailed overviews of all classes, methods, and so on.
## Further Help
Stuck? Drop a line in my Discord server and I will help you out.
