polymod icon indicating copy to clipboard operation
polymod copied to clipboard

Rework metadata schema to add additional fields.

Open EliteMasterEric opened this issue 4 years ago • 3 comments

The current format of the _polymod_meta.json is workable but lacking in important areas. Notably, the author attribute does not provide the ability to easily specify multiple authors or to specify contact info for those authors.

Other attributes could also be added, such as homepage (to provide a URL that users can click to navigate to the mod's download page), versionUrl (to provide a URL which Polymod can query to determine if the mod is outdated), metadataVersion (in the event that breaking changes to the metadata file format are needed), keywords (to be used to assist searching for the distribution in a larger catalog implemented by a third party) and possibly dependencies (mods which must have a compatible version be loaded before this one is allowed to be loaded).

Modpacks could also be reworked. Modpack data could be moved into the metadata file, and additional attributes could be added (such as the ability to set the download link for each mod in the modpack, to provide to the user should an individual mod be missing).

Think about the required use cases, construct a new backwards-compatible schema for the layout of the _polymod_meta.json file, and implement the changes.

EliteMasterEric avatar Sep 15 '21 04:09 EliteMasterEric

Moved to MasterEric/Polymod#9.

EliteMasterEric avatar Nov 06 '21 01:11 EliteMasterEric

Unmove.

EliteMasterEric avatar Nov 18 '21 10:11 EliteMasterEric

The metadata format now includes the homepage and contributors attributes.

versionURL moved to #73

dependencies moved to #35

keywords isn't that useful and has been dropped.

EliteMasterEric avatar Jan 30 '22 08:01 EliteMasterEric