-
Notifications
You must be signed in to change notification settings - Fork 10
Getting Started on 1.20.2 and Up
The recommended way of adding FCAP to your project is via Gradle in your build.gradle
file.
In the groovy snippets make sure to replace <modVersion>
with the version of FCAP you intend to use. Version numbers have a pretty simple form such as 8.0.0
(for Minecraft 1.20.1) or 20.4.2
(for Minecraft 1.20.4).
All available versions can be viewed on CurseForge & Modrinth.
FCAP is available as multiple distributions depending on the mod loader / type of project you want to use it on. You will not need to depend on FCAP on the mod loader the config system is ported from. The table below shows what config system (either NeoForge's or Forge's) is available in which distribution.
Project Type | Distribution Name | NeoForge Api | Forge Api | Namespace |
---|---|---|---|---|
Common | forgeconfigapiport-common-neoforgeapi |
✅ | ❌ | Named |
Common | forgeconfigapiport-common-forgeapi |
❌ | ✅ | Named |
Fabric | forgeconfigapiport-fabric |
✅ | ✅ | Intermediary |
NeoForge | forgeconfigapiport-neoforge |
❌ | ✅ | Named |
Forge | forgeconfigapiport-forge |
✅ | ❌ | Srg |
So i.e. if you want to use the NeoForge Api for your project, you will need to:
- depend on
forgeconfigapiport-common-neoforgeapi
for yourCommon
module (if available) - depend on
forgeconfigapiport-fabric
for yourFabric
module (if available) - depend on
forgeconfigapiport-forge
for yourForge
module (if available) - not depend on the NeoForge distribution as the api is already available as part of the mod loader itself
repositories {
maven {
name = "Fuzs Mod Resources"
url = "https://raw.githubusercontent.com/Fuzss/modresources/main/maven/"
}
}
dependencies {
// NeoForge's config system
api "fuzs.forgeconfigapiport:forgeconfigapiport-common-neoforgeapi:<modVersion>"
// Forge's config system
api "fuzs.forgeconfigapiport:forgeconfigapiport-common-forgeapi:<modVersion>"
}
dependencies {
modApi "fuzs.forgeconfigapiport:forgeconfigapiport-fabric:<modVersion>"
}
dependencies {
api "fuzs.forgeconfigapiport:forgeconfigapiport-neoforge:<modVersion>"
}
dependencies {
api(fg.deobf("fuzs.forgeconfigapiport:forgeconfigapiport-forge:<modVersion>"))
}