diff options
-rw-r--r-- | docs/SUMMARY.md | 2 | ||||
-rw-r--r-- | docs/modding/finishing-touches.md | 17 | ||||
-rw-r--r-- | docs/modding/publishing.md | 39 |
3 files changed, 40 insertions, 18 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 38ace26..2b23989 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -52,7 +52,7 @@ * [Keyvalues](modding/keyvalues.md) * [Setup Syntax Highlighting](modding/squirrel/setup-syntax-highlighting.md) * [Localisation](modding/localisation\_files.md) - * [Finishing touches](modding/finishing-touches.md) + * [Publishing](modding/publishing.md) * [Development](development.md) ## Other diff --git a/docs/modding/finishing-touches.md b/docs/modding/finishing-touches.md deleted file mode 100644 index e993b5e..0000000 --- a/docs/modding/finishing-touches.md +++ /dev/null @@ -1,17 +0,0 @@ -# Finishing touches - -## Best practices - -Make sure to name your mod in the form `<your name>.<mod name>`, similar to the existing default mods, like `Northstar.Client`, `Northstar.CusomServer`, ... \ -Note that the Northstar name (`Northstar.xyz`) is reserved for mods delievered with the Northstar install and should therefore **NOT** be used. - -It is recommended to upload the source code of your mod to a public repository like [Github](https://github.com/) to give your users a place to suggest changes and leave feedback in an organised manner. - -## Mod submission - -Currently the designated place to share your mods with others are two Discord channels in the in the _Modding_ category on the [Northstar Discord](https://northstar.tf/discord): - -- `#northstar-client-mods` for client-side only mods like HUD changes, skins, etc. -- `#northstar-server-mods` for mods that primarily target servers, like new gamemodes, moderation tools, etc. - -[Thunderstore](https://thunderstore.io/) support is planned for the future to offer an easily searchable platform for downloading and submitting mods. diff --git a/docs/modding/publishing.md b/docs/modding/publishing.md new file mode 100644 index 0000000..087a576 --- /dev/null +++ b/docs/modding/publishing.md @@ -0,0 +1,39 @@ +# Publishing your mod + +## Best practices + +Make sure to name your mod in the form `<your name>.<mod name>`, similar to the existing default mods, like `Northstar.Client`, `Northstar.CusomServer`, ... \ +Note that the Northstar name (`Northstar.xyz`) is reserved for mods delievered with the Northstar install and should therefore **NOT** be used. + +It is recommended to upload the source code of your mod to a public repository like [Github](https://github.com/) to give your users a place to suggest changes and leave feedback in an organised manner. + +## Thunderstore + +The best place to publish your mod is [Thunderstore](https://northstar.thunderstore.io/). To do so, you need to package your mod as a zip with a specific folder structure. You can either set the structure up manually or use [this GitHub template](https://github.com/laundmo/northstar-mod-template) + +## Thunderstore package structure + +The Thunderstore package zip structure is as follows: + +``` +mods/<your name>.<mod name>/ +icon.png +manifest.json +README.md +``` + +- `icon.png`: 256x256px icon for your mod. +- `README.md`: the description page for your mod +- `manifest.json` outlined [here](https://northstar.thunderstore.io/package/create/docs/) + +You can put multiple mods in the `mods/` folder, but only do this if neccessary. + +manifest.json checker: [https://northstar.thunderstore.io/tools/manifest-v1-validator/](https://northstar.thunderstore.io/tools/manifest-v1-validator/) + +## Uploading + +After you have set up the folder structure, head to [https://northstar.thunderstore.io](https://northstar.thunderstore.io) and log in with either Discord or Github. Then you can use the _Upload_ button at the top of the page to upload your zip. + +When uploading, it will verify your package structure and you can publish after it's successfully checked. + +To update a mod, change the version in mod.json and manifest.json, and upload again. If the mod name is the same, it will update the previous version.
\ No newline at end of file |