search

larsiusprime / polymod

Atomic modding framework for Haxe
MIT License
161 stars 62 forks source link

Rework metadata schema to add additional fields. #32

Open EliteMasterEric opened 3 years ago

EliteMasterEric commented 3 years ago

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 commented 2 years ago

Moved to MasterEric/Polymod#9.

EliteMasterEric commented 2 years ago

Unmove.

EliteMasterEric commented 2 years ago

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.