NeoForm provides steps to create reproducible and recompilable Minecraft source code.
Development versions of Minecraft for a release version will be on a branch named <version>-dev
Definitions:
type
can be eitherrelease
(release versions)pre
(pre-releases and release candidates)snapshot
(snapshots)
ver
is a major version of Minecraft without the ending.0
version
is a specific version of Minecraft
options in local.properties
can be set to filter for which versions are loaded by gradle:
type
(defaults torelease
)ver
(defaults to all major versions)
Gradle tasks:
:<version>:projectApplyAll
- Creates Minecraft source code of that version with patches applied:<version>:projectMakeAll
- Generates patches for the specified versionupdate
- Requiresold_version
andnew_version
to be specified ingradle.properties
in the format of<type>/<ver>/<version>
.:<version>:testJdks
- Checks that the generated source code is consistant across java versions along with compilation Sets up the new version based on the old version without the patches from the old version
Check For New Snapshots
- Runs every 30 minutes from 6am to 7pm UTC and checks for when Mojang releases a new version and runs theUpdate
workflowUpdate
- Runs theupdate
task and checks for any library updates along with copying over the patches from the old version to the new version then attempts to run theCheck
workflow. Parameters:Old branch
- The branch name where the old version isOld version
-<type>/<ver>/<version>
of the old versionPatches version
(deprecated) -<type>/<ver>/<version>
of the version to take the patches from (defaults toOld version
)New branch
- The branch name of where the new version will be (defaults toOld branch
)New version
-<type>/<ver>/<version>
of the new versionFix known error(s) in mapping file
(deprecated) - Was used for when Jammer would generate incorrect names for fields or methodsCopy extras
- When changing branches copy over files outside of theversions
and.github
directoriesPublish
- Passed toCheck
workflow
Check
- Required to run from the branch with the version being checked and checks if patches successfully apply and runs:<version>:testJdks
and optionally publishes to the NeoForge maven. Parameters:Version
-<type>/<ver>/<version>
of the versionPush changed patches
- If enabled and running:<version>:projectApplyAll
then:<version>:projectMakeAll
changes patches then it pushes the updated patchesPublish
whether to publish to the NeoForge maven
This project uses the obfuscation logs provided by Mojang for Minecraft in order to generate its data. That means that the data here could be considered a derivative work of those mappings. So you should be fully versed in the license associated with those official mappings. You can read more about our interpretation of them here.