diff --git a/docs/source/guides/publishing.rst b/docs/source/guides/publishing.rst index 2a4849e8..c4184e33 100644 --- a/docs/source/guides/publishing.rst +++ b/docs/source/guides/publishing.rst @@ -58,4 +58,22 @@ Github Workflows If you want to create a Github repository for your mod, you can use a `template `_ that automatically packages and uploads your mod to Thunderstore when you create a Github release of your mod. -Github only supports files smaller than 100mb without using `git-lfs `_. Using git-lfs isn't recommended. Instead you should use scripts that split your assets like in this `template `_ \ No newline at end of file +Github only supports files smaller than 100mb without using `git-lfs `_. Using git-lfs isn't recommended. Instead you should use scripts that split your assets like in this `template `_ + +Verified mods +------------- + +If you server requires client-side mods, when people connect to it, they will see this kind of message: + +.. image:: ../img/missing_mod_screenshot.png + :width: 1000 + :alt: Game client displays a "required mod" message. + +This requires players to manually download required mods, which prevents them from playing straight away, and thus breaks user experience. + +Fortunately, to counter that, Northstar integrates a *verified mod* feature: if a mod is missing and it has been verified by the Northstar team, game clients will automatically download it. + +.. note:: + Only client-side mods that are required by a server are eligible for verification (*i.e* no need to verify **client-side only** mods like skins or server-only mods). + +If you're interested in verifying mods, you'll find all instructions on the `verified mods repository `_. \ No newline at end of file diff --git a/docs/source/img/missing_mod_screenshot.png b/docs/source/img/missing_mod_screenshot.png new file mode 100644 index 00000000..e26019e2 Binary files /dev/null and b/docs/source/img/missing_mod_screenshot.png differ