Skip to content

Commit

Permalink
docs: update README regarding updated manifesto format
Browse files Browse the repository at this point in the history
  • Loading branch information
Alystrasz committed Jul 9, 2024
1 parent aa7158c commit f8a879a
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,17 @@ This verified mods enables players to join servers that require custom content s

Verified mods are listed in the present `verified-mods.json` file, using following format:
* Key is mod's name (contained in its `mod.json` manifest's "Name" key);
* Body holds three fields:
* "DependencyPrefix" contains the string that allows Northstar to retrieve mods on Thunderstore;
* Body holds two fields:
* "Repository" contains the link of the repository hosting the source code of the mod;
* "Versions" contains a list of version (for the current mod) that have been verified.

Each version contains the following attributes:
* "Version" is the current version identifier (using the `x.y.z` format);
* "CommitHash" is the Git commit associated to the current version;
* "DownloadLink" is the direct download link of the version archive;
* "Checksum" is the SHA256 hash of the version archive;
* "Platform" is the origin of the version ("thunderstore" is currently the only supported option).

## How to submit a mod for verification

Before starting to submit your mod for verification, please ensure that it is a valid candidate to mod verification! Only mods required by a server to be client-side can be verified.
Expand Down

0 comments on commit f8a879a

Please sign in to comment.