Replace special-cased ID with game field

modip-org / spec

Please use Modrinth's spec - https://github.com/modrinth/docs/blob/master/docs/modpacks/format_definition.md

Creative Commons Zero v1.0 Universal

2 stars 2 forks source link

Replace special-cased ID with game field #6

Closed stairman06 closed 4 years ago

stairman06 commented 4 years ago

This removes the special case ID of minecraft, and replaces it with game which is more extensible. Changes so far:

[X] Replace special case ID in format_example.modip.json
[X] Add definition of game and remove special case ID definition
[X] Add basic implementation guide
[X] Expand implementation guide details
[X] Fix all examples

I will clarify why I didn't simply add a src field for the special-cased minecraft: Everything implementing MODIP will have a source of Minecraft metadata. MODIP isn't focused on being completely game-agnostic. Therefore, I believe distributing metadata and links to the actual game is out of scope - the data is guaranteed to already exist.

stairman06 commented 4 years ago

Compatibility database bikeshedding: should it support/require snapshots? There's an obvious benefit, which is great for mods that run on snapshots, but you get a few problems. First: you know have to list every snapshot, which means larger file size, and slower to parse and process. Second: snapshots are buggy, your mod could be broken in one snapshot but fixed in the next. That can mess up the whole timeline.

We could exclude snapshots altogether, but that would be annoying. We could also separate snapshots or do some indication that they don't count from a release -> release comparison, but that's complicated.

Or we could just have no compatibility DB. Hmm.

stairman06 commented 4 years ago

Compat DBs have been removed. I have personally changed opinion, and I believe now it's better to not have compat DBs at all and leave it up to launchers to make assumptions, and even if we decide to use compat DBs again they can just go into a separate PR.