Repository navigation
change recipes
Meatwo310 edited this page Jul 15, 2026
·
1 revision
Use the checklist closest to the requested change. Keep scope narrow unless the request explicitly asks for a broad update.
- Decide whether the code is cross-version (
common/src/main) or tied to one Minecraft version (<mc>/common/src/main). - Keep package names aligned with existing
net.meatwo310.examplemodclasses. - If the shared API changes, update every loader project that calls it.
- Build representative downstream projects:
./gradlew :1.18.2-forge:build :1.20.1-fabric:build :26.1-neo:build- Put Fabric code under
<mc>/fabric, LexForge code under<mc>/forge, and NeoForge code under<mc>/neo. - Keep entrypoint names consistent with
gradle.propertiesand metadata templates. - For Fabric client code, use
src/client/java. - For Forge and NeoForge client-only code, follow the existing project pattern before adding a new source set.
- Build the affected project:
./gradlew :<mc>-<loader>:build- Put shared declarations in
common/src/config. - Put version-specific config helpers in
<mc>/common/src/config. - Put loader config registrar code in
<mc>/<loader>/src/config. - Put client config UI code in
<mc>/<loader>/src/configClientwhen that loader convention supports it. - Confirm the affected project applies the right
*-config-conventionsplugin. - For Fabric config dependencies, check Forge Config API Port and any runtime UI mods such as Mod Menu or Forge Config Screens.
- Build one affected project per loader family.
- Add
<mc>/common. - Add one or more loader project directories:
<mc>/fabric,<mc>/forge,<mc>/neo. - Add
include(...)entries insettings.gradle.kts. - Add each subproject
build.gradle.kts. - Add each subproject
gradle.propertieswithminecraftVersionand required loader, Java, mapping, and dependency versions. - Copy only the needed source files from the nearest existing version, then adapt API differences.
- Add metadata templates under each loader project's
src/main/templates. - Run:
./gradlew --configuration-cache --no-daemon writeCiBuildMatrix
./gradlew :<mc>-common:build :<mc>-<loader>:build- Confirm
<mc>/commonexists and is included. - Add
<mc>/fabric,<mc>/forge, or<mc>/neo. - Add the project to
settings.gradle.kts. - Use the matching convention plugins:
- Fabric:
fabric-loom-mod-conventionsorfabric-loom-remap-mod-conventions - Fabric API:
fabric-api-conventions - Fabric config (1.20.1+):
fabric-config-conventions - Fabric Legacy config (1.18.2-1.19.2):
fabric-legacy-config-conventions - LexForge Legacy:
lexforge-legacy-mod-conventions - LexForge Legacy config:
lexforge-legacy-config-conventions - LexForge (ForgeGradle 7+):
lexforge-mod-conventions - LexForge config:
lexforge-config-conventions - NeoForge:
neoforge-mod-conventions - NeoForge config:
neoforge-config-conventions
- Fabric:
- Add loader metadata templates and runtime dependencies.
- Run
writeCiBuildMatrixand the new project build.
- Prefer root
gradle.propertiesfor shared values such as mod id, name, license, authors, URLs, credits, and Fabric entrypoints. - Prefer subproject
gradle.propertiesfor Minecraft, loader, Java, mappings, and runtime dependency versions. - Edit templates only when the metadata shape changes.
- Build one Fabric and one Forge/NeoForge project if template expansion changed.
- Fabric: edit
src/main/templates/fabric.mod.jsonand checkfabric-mod-conventions. - LexForge: edit
src/main/templates/META-INF/mods.tomland checklexforge-mod-conventionsorlexforge-legacy-mod-conventions, according to the ForgeGradle generation. - NeoForge: edit
src/main/templates/META-INF/neoforge.mods.tomland checkneoforge-mod-conventions. - If a new placeholder is introduced, add it to the matching
replacePropertiesor default metadata map. - Run the affected loader project build and inspect generated resources if the change is risky.
- Read the
Dependenciessection indocs/README.mdfirst. - Use
gradle/libs.versions.tomlfor shared aliases. - Use subproject
gradle.propertiesfor per-version dependency versions. - Add local
runClient/runServerdependencies in the affected loader project'sbuild.gradle.kts. - Use
ciRuntimeModsfor jars that GitHub Actions runtime tests must copy intorun/mods; do not use it as a local run dependency. - If code references dependency classes, add a compile dependency as well as any runtime or CI staging dependency that target needs.
- Build the affected project and confirm
build/ciRuntimeModswhen runtime mods are expected.
- Identify which convention plugin owns the behavior.
- Keep common behavior in helper functions under
net/meatwo310/mdk/build. - Avoid duplicating logic across Fabric, Forge, and NeoForge conventions unless their Gradle plugins require different APIs.
- Run at least:
./gradlew --configuration-cache --no-daemon writeCiBuildMatrix
./gradlew :1.20.1-fabric:build :1.20.1-forge:build :26.1-neo:build- For build matrix behavior, update
writeCiBuildMatrixin rootbuild.gradle.kts. - For workflow execution behavior, update
.github/workflows/build.yml. - For version bumping, jar collection, release notes, tags, or GitHub Release
behavior, update
.github/workflows/release.yml. - Run
writeCiBuildMatrixlocally after matrix-related changes. - Check that docs-only changes are still ignored by the build workflow unless the requested change says otherwise.
- Edit
version.txtonly when intentionally setting the release version. - Keep the value as a plain semantic version with no
vprefix. - Release tags are created as
v<version>by the workflow. - Do not change archive version formatting unless release artifact names are part of the task.