From f8a879a1f7d8be3f9ac85b60157327689b1f6358 Mon Sep 17 00:00:00 2001 From: Remy Raes Date: Tue, 9 Jul 2024 22:48:58 +0200 Subject: [PATCH] docs: update README regarding updated manifesto format --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 80c42c8..9d26728 100644 --- a/README.md +++ b/README.md @@ -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.