Specification Draft

[stairman06]

This is a specification draft based on previous discussions. Any feedback or thoughts are appreciated.

[stairman06]

Made some modifications based on feedback:

• Icons are now in the media array
• Media objects can now have an SHA256 hash
• authors supports Teams
• Authors have IDs
• Projects can have multiple successors and predecessors
• WebM is now recommended over MP4
• Dependencies can now be both for the Version and for the File
• The file.frameworks field has been removed
• Files now have a rel field
• installationMethod now has support for any directory
• download field has been simplified and renamed to downloads

[stairman06]

I've made some more revisions:

• The src value for files contains more information, and now mentions the API made by immibis (PR #3)
• installationMethod has been renamed to installation and is now an object.
• installation can now be at the version level and file level.
• releaseDate now contains more information about the ISO-8601 format and provides an example.
• An example for a framework using the MCIP Format, format_example_fabric, has been created.
• More license information and values have been added.
• The format_values.md file contains a list of different values that fields can have, such as standard framework names and file rel values.
• format_introduction now describes the standard API and provides information on how launchers can use this
• Media Items can now have mutliple rels
• Dependencies can now have multiple src values
• modpackUsage now overrides any restrictions set in the license
• installation is now a required field - it MUST be present at either the version level or the file level
• More info about semver and the versions object

[immibis]

You put "icon": "image" instead of "type": "image"

[immibis]

Can we move the installation data to a different PR since it's a lot more complex than we thought?

[stairman06]

Created PR #7 for discussion of installation data.

[stairman06]

Did some more work:

• Categories become Tags and there are now some standardized values
• Moved guides/tips for launchers to a separate file and added HTML guide
• Dependency cleanup
• Removal of references to MCIP Standardized API as it had little purpose
  • Redefined dependency src field to allow offsite dependency metadata
• Grammatical fixes
• General cleanup and fixing
• Add compressedOverrides file rel value

[stairman06]

Now added: conditions. Conditions allow you to describe where a Project can be used. Currently, the only available condition options are clientside and serverside. Conditions can either be defined in a separate conditions field, or directly in a field. You can find examples in format_spec.md, line 278. An example is also in format_example_modpack.json

[stairman06]

Repository abandoned. Moved to modip-org/spec.