aboutsummaryrefslogtreecommitdiff
path: root/docs/modding/squirrel/setting-mods/the-json.md
diff options
context:
space:
mode:
authorJMM889901 <41163714+JMM889901@users.noreply.github.com>2022-01-27 13:21:56 +0000
committerGitHub <noreply@github.com>2022-01-27 14:21:56 +0100
commit8ebc0a67c03886fe09c771af432683500ecabf83 (patch)
tree985b2cd15796b6a4d5142dc7653b4206fe907cb1 /docs/modding/squirrel/setting-mods/the-json.md
parent7f08b061845ca4f926b939acad6bd2dea8a7dce3 (diff)
downloadNorthstarWiki-8ebc0a67c03886fe09c771af432683500ecabf83.tar.gz
NorthstarWiki-8ebc0a67c03886fe09c771af432683500ecabf83.zip
Began adding entries for squirrel GNUT scripting (#27)
* bruh * Update what-is-squirrel.md * Create Handling-threads-and-waits.md * Update Handling-threads-and-waits.md * Update What-are-callbacks.md * i got locked out while making this * Update what-is-squirrel.md * confusion is bad * funne colors * bruh * Language moment * Update the-mod-file.md * Json moment * Update The-JSON.md * Update The-JSON.md * Update The-JSON.md * Update The-language-file.md * Update The-language-file.md * Update the-mod-file.md * Update The-language-file.md * Create The-mod-init.md * got distracted, will finish later * pain * Update The-mod-init.md * fixed typo * Rename What-are-callbacks.md to what-are-callbacks.md * Rename Loops-Functions-and-if.md to loops-functions-and-if.md * Rename docs/modding/squirrel/Setting mods/the-mod-file.md to docs/modding/squirrel/setting-mods/the-mod-file.md * Rename docs/modding/squirrel/Setting mods/The-language-file.md to docs/modding/squirrel/setting mods/the-language-file.md * Rename docs/modding/squirrel/Gamemode mods/The-mod-init.md to docs/modding/squirrel/gamemode mods/the-mod-init.md * Rename Handling-threads-and-waits.md to handling-threads-and-waits.md * Rename docs/modding/squirrel/Setting mods/The-JSON.md to docs/modding/squirrel/setting mods/the-json.md * Rename Respawns-Functions.md to respawns-functions.md * Rename docs/modding/squirrel/gamemode mods/the-mod-init.md to docs/modding/squirrel/gamemode-mods/the-mod-init.md * Rename docs/modding/squirrel/setting mods/the-json.md to docs/modding/squirrel/setting-mods/the-json.md * Rename docs/modding/squirrel/setting mods/the-language-file.md to docs/modding/squirrel/setting-mods/the-language-file.md * tables do kinda be cool tho * var is better now * bruh
Diffstat (limited to 'docs/modding/squirrel/setting-mods/the-json.md')
-rw-r--r--docs/modding/squirrel/setting-mods/the-json.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/modding/squirrel/setting-mods/the-json.md b/docs/modding/squirrel/setting-mods/the-json.md
new file mode 100644
index 0000000..db80a55
--- /dev/null
+++ b/docs/modding/squirrel/setting-mods/the-json.md
@@ -0,0 +1,38 @@
+The mod.json
+============
+
+The mod.json is responsible for governing when, and where your mod is loaded, and follows a layout that is fairly complicated at first glance, but ultimately simple
+
+```json
+{
+ "Name" : "SimpleRandomiser",
+ "Description" : "SimpleRandomiser",
+ "Version": "0.1.0",
+ "LoadPriority": 1,
+```
+The script above defines the pubic and listed details of the mod
+```json
+ "Scripts": [
+ {
+ "Path": "sh_SimpleRandomiser.gnut",
+ "RunOn": "MP",
+ "ClientCallback": {
+ "After": "simplerandomiser_init"
+ },
+
+ "ServerCallback": {
+ "After": "simplerandomiser_init"
+ }
+ }
+ ],
+```
+The scirpt above defines both what functions to run, when to run them and WHERE to run them, in this case it runs your simplerandomiser_init, when on multiplayer and for both the server and the client
+```json
+ "Localisation": [
+ "resource/simplerandomiser_localisation_%language%.txt"
+ ]
+}
+```
+this defines the path to the language file
+
+name this file mod.json, and it should go in the mods root folder