modpack.lock v1

[JaronZ]

Background

Blocksmith needs a way to easily identify transitive mod dependencies (meaning mods that other mods require) and the exact version of a mod being used in the modpack. it also needs something to identify when the file of a mod version has changed, whether malicious or by accident. This will make the tool both faster and more secure.

Proposal

A modpack.lock file containing all mods (including transitive mods) with exact versions that can be downloaded so everyone that works on the modpack has the exact same mod versions. This can also be used with a hash, so to prevent issues when a file changes in a version. Lastly, it will make the installation faster, because it can download the exact version directly from the source.

Here is an example of what the lock file could look like:

lockfileVersion: 1

modpack:
  name: MyCoolPack
  version: 1.0.0
  minecraftVersion: 1.20.1
  modLoader:
    name: forge
    version: 47.1.3

mods:
  # Mods indexed by "source:projectId@version"
  curseforge:32274@5.9.0:
    name: JourneyMap
    fileId: 4516823
    filename: journeymap-5.9.0.jar
    download:
      url: https://media.forgecdn.net/files/4516/823/journeymap-5.9.0.jar
      sha256: 3c87e46b2b7c8e...

  modrinth:AANobbMI@0.5.3:
    name: Sodium
    fileId: 9fbc12e3
    filename: sodium-fabric-mc1.20.1-0.5.3.jar
    download:
      url: https://cdn.modrinth.com/data/AANobbMI/versions/9fbc12e3/sodium.jar
      sha256: 98f6bb7a6e6e...

Motivation

No response

Stage

• Draft
• Proposal
• Ready
• In Progress
• Implemented