aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeckoEidechse <gecko.eidechse+git@pm.me>2022-01-28 18:02:22 +0100
committerGeckoEidechse <gecko.eidechse+git@pm.me>2022-01-28 18:02:22 +0100
commitdac76080576014b7c7c3f5de18244340b198deac (patch)
tree36b311c0fce51d575e6a5ea6e9c3004b0c5394f7
parentabbbd4682bafee119c89982f2de92f75feb10891 (diff)
downloadNorthstarWiki-dac76080576014b7c7c3f5de18244340b198deac.tar.gz
NorthstarWiki-dac76080576014b7c7c3f5de18244340b198deac.zip
Add page about making finishing touches to a mod
-rw-r--r--docs/SUMMARY.md1
-rw-r--r--docs/modding/finishing-touches.md17
2 files changed, 18 insertions, 0 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index 116b6d8..3241096 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -48,6 +48,7 @@
* [Callbacks](modding/squirrel/what-are-callbacks.md)
* [Setup Syntax Highlighting](modding/squirrel/setup-syntax-highlighting.md)
* [Localisation](modding/localisation\_files.md)
+ * [Finishing touches](modding/finishing-touches.md)
* [Development](development.md)
## Other
diff --git a/docs/modding/finishing-touches.md b/docs/modding/finishing-touches.md
new file mode 100644
index 0000000..e993b5e
--- /dev/null
+++ b/docs/modding/finishing-touches.md
@@ -0,0 +1,17 @@
+# 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.