QuiltMC / quilt-mappings

Quilt's Mappings for Minecraft
Creative Commons Zero v1.0 Universal
96 stars 76 forks source link

move QM onto a mojmap base #660

Open ix0rai opened 1 month ago

ix0rai commented 1 month ago

description and motivation

as previously suggested by @LambdAurora, we will be moving QM onto a mojmap base to improve the mappings and compensate for the small size of our team. this means that all entries in QM will be mojmap unless they are manually mapped by our team. this will have a couple benefits:

we will also be enforcing mojang's package structure on QM, which has the benefits of:

implementation

this implementation will come in three parts:

some other stuff that has to happen to enable this:

sylv256 commented 1 month ago

why not just use https://github.com/LambdAurora/yalmm?

ix0rai commented 1 month ago

simple! we want to focus on our own names, while her project is aimed at fixing problematic mojmap names.

ix0rai commented 3 weeks ago

one more unsolved tech consideration here: ideally, the package names would be saved in the main mappings, unlike all other proposers. this would keep the file structure of the repo matching the package structure for the mappings. my idea for this is simply to add a false-by-default boolean in the service for whether to ignore writeProposedNames in MappingSaveParameters

ix0rai commented 3 weeks ago

one more unsolved tech consideration here: [...]

after putting some thought into this, I've decided the best method is simply to add a bypassChecks boolean to allow setting the token type of proposed mappings to deobf. i've implemented this in https://github.com/QuiltMC/enigma/pull/240, and made sure to include javadoc telling you to under no circumstances use it.