Repository navigation
dependency recipes
Meatwo310 edited this page Jul 15, 2026
·
1 revision
Use the Dependencies section in docs/README.md as the source of truth for
configuration names. This file only adds agent-facing checks.
Answer these in order:
- Which included subproject owns the dependency? Check
settings.gradle.kts. - Is it a mod jar or a normal Java library?
- Does source code import or call dependency classes?
- Is it needed only for local
runClient/runServer? - Does GitHub Actions need the jar copied into
run/mods? - Does production loader metadata need to require the dependency?
Do not use ciRuntimeMods just because a dependency is runtime-only. Use it only
when the external runtime test in CI needs a physical jar next to the built mod.
-
fabric-api-conventionsalready adds Fabric API with the correct Fabric configuration for the selected Loom plugin. -
fabric-config-conventionsandfabric-legacy-config-conventionsalready add the matching Forge Config API Port dependency to compile classpaths,ciRuntimeMods, and generated Fabric metadata. - Existing Fabric Mod Menu dependencies are local runtime UI helpers; they are
not staged through
ciRuntimeMods. - Existing LexForge Legacy Configured dependencies are local runtime UI helpers.
- Prefer the configurations documented in
docs/README.md; do not introduce seldom-used configurations unless a loader plugin requires them for the concrete dependency.
Gradle dependencies and production loader metadata are separate.
- Add Fabric metadata through
fabricModMetadata.depend(...)for systematic convention-owned dependencies. - Add target-specific Fabric metadata in
src/main/templates/fabric.mod.json. - Add LexForge production dependencies in
src/main/templates/META-INF/mods.toml. - Add NeoForge production dependencies in
src/main/templates/META-INF/neoforge.mods.toml. - Do not mark soft integrations as required metadata.
Run:
./gradlew :<mc>-<loader>:buildIf ciRuntimeMods was changed, confirm staging:
find <mc>/<loader>/build/ciRuntimeMods -maxdepth 1 -type f -name '*.jar'If project inclusion or CI matrix assumptions changed, run:
./gradlew --configuration-cache --no-daemon writeCiBuildMatrix