search

QuiltMC / rfcs

Repository for requests for comments for proposing changes to the Quilt Project.
Other
61 stars 33 forks source link

RFC 2 amendment: add `intermediate_mappings` field to `quilt.mod.json` #52

Closed TibiNonEst closed 2 years ago

TibiNonEst commented 2 years ago

An amendment to RFC 2 per https://github.com/QuiltMC/quilt-loader/issues/59.

Adds an optional string field to quilt.mod.json in the quilt_loader section named intermediate_mappings. This string will be used to determine which mappings a mod uses once hashed support is added to QL. The two values it will accept are "hashed" and "intermediary".

zml2008 commented 2 years ago

How about using maven coordinates for this, to have a global identifier for mappings, such as net.fabricmc:intermediary and org.quiltmc:hashed. This would allow for other namespaces to be contributed, say by loader plugins -- if someone wanted to do say a custom intermediary for legacy versions, or use srg.

chexo3 commented 2 years ago

That would definitely be nice

TibiNonEst commented 2 years ago

My initial idea was that loader plugins could register additional intermediate mapping identifiers such as "legacy" or whatever such an identifier may be, although I think using maven coordinates may be better for guaranteeing uniqueness and may make loader plugins easier to create down the line.

TheGlitch76 commented 2 years ago

I agree, the maven coordinates would be better for a general approach.

Should we bother providing aliases matching what was initially proposed here (reserved just for hashed and fabric intermediary), or always use the maven coordinates?

chexo3 commented 2 years ago

I agree, the maven coordinates would be better for a general approach.

Should we bother providing aliases matching what was initially proposed here (reserved just for hashed and fabric intermediary), or always use the maven coordinates?

If we were already using this code in production it would make sense, but in this case we can do it without having to worry about old mods, so aliases might be kind of pointless. I think in this case being specific makes sense.

TheGlitch76 commented 2 years ago

Can an admin merge this, please?

OroArmor commented 2 years ago

I'll merge when the last comment is resolved.

triphora commented 2 years ago

@OroArmor You can just commit it yourself, no? I didn't mean for that to be a blocking comment, just didn't want a typo

OroArmor commented 2 years ago

You're right I can.