Add Parchment mappings layer #138
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MattSturgeon
commented
Dec 28, 2023
MattSturgeon
changed the title
`parchment_version` can be set to the plain version, if the parchment appendix matches `minecraft_version`. Otherwise, it should be formatted `appendix-version`.
MattSturgeon
force-pushed
the
parchment
branch
from
082be43 to
6af5a3c
Compare
Co-authored-by: Matt Sturgeon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds parchment mappings.
Mojang's mappings cover class, method, & field names. Parchment builds on this by providing mappings for parameter names and some javadocs, though not nearly as much javadoc as yarn currently has.
I slightly over-complicated things by making the parchment minecraft version optional:
parchment_versioncontains a hyphen, the first part is the minecraft version, appended to the artifact name.minecraft_versionis used instead.This means when parchment has a release exactly matching the minecraft version we're using, we don't need to specify it twice.
For example, we are using 1.20.4, however Parchment has a stable build for 1.20.2 and unstable builds for 1.20.3. Therefore we currently need to specify two different mc versions.
If you don't think the complexity is worth it, I can remove the complexity and we'll always specify parchment's mc version explicitly.
We may also want to be able to disable parchment. We could do this by adding a check for
project.parchment_version == "off"(or similar). Or we could comment the parchment line on an ad-hoc basis.