aboutsummaryrefslogtreecommitdiff
path: root/modding
diff options
context:
space:
mode:
Diffstat (limited to 'modding')
-rw-r--r--modding/api/.gitkeep0
-rw-r--r--modding/cheatsheet.md0
-rw-r--r--modding/convars.md0
-rw-r--r--modding/getting-started.md63
-rw-r--r--modding/keyvalues.md0
-rw-r--r--modding/localisation_files.md0
-rw-r--r--modding/squirrel/what-is-squirrel.md0
-rw-r--r--modding/tutorials/1-first-mod/.gitkeep0
-rw-r--r--modding/tutorials/2-creating-vscripts/.gitkeep0
-rw-r--r--modding/tutorials/3-particles-and-vmts/.gitkeep0
-rw-r--r--modding/tutorials/modding-tutorials.md0
11 files changed, 63 insertions, 0 deletions
diff --git a/modding/api/.gitkeep b/modding/api/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/modding/api/.gitkeep
diff --git a/modding/cheatsheet.md b/modding/cheatsheet.md
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/modding/cheatsheet.md
diff --git a/modding/convars.md b/modding/convars.md
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/modding/convars.md
diff --git a/modding/getting-started.md b/modding/getting-started.md
new file mode 100644
index 0000000..b9ee1f5
--- /dev/null
+++ b/modding/getting-started.md
@@ -0,0 +1,63 @@
+# Getting Started with Modding
+
+## Basics
+This guide assumes you have basic understanding with programming and know how to use developer environments.
+Listed below are tools useful for exporting file formats
+
+If you'd like a more lengthy set of tutorials covering many topics. Look at:
+{% content-ref url="modding/getting-started-with-modding"}
+[modding-tutorials](tutorials/modding-tutorials.md)
+{% endcontent-ref %}
+
+
+> TODO: Actually link tools
+### Tools
+* RSPNVPK
+* Cra0 VPK Tool (Titanfall VPK Tool)
+* Legion by DZXTPorter
+
+## Quick start
+In order to get started with making your mod, create a folder in `R2Northstar/mods`. While it isn't required, it is best practise by mod authors to follow the naming scheme "Author.ModName", such as "Northstar.Client".
+
+After making this folder, inside it add a folder named `mod` and a file named `mod.json`.
+
+Provided is a template `mod.json`, for a detailed list of values read [Cheatsheet](./cheatsheet.md)
+
+```json
+{
+ "Name": "My.Mod",
+ "Description": "Woo yeah wooo!",
+
+ "LoadPriority": 0,
+ "ConVars": [],
+ "Scripts": [],
+ "Localisation": []
+}
+```
+
+Inside the `mod` folder, existing files found in the engine's virtual file system will be overwritten and new files can be added. If you need to define new Squirrel files (.nut/.gnut) they *must* be declared in the `"Scripts"` array in `mod.json`. An example for this might be:
+
+```json
+ "Scripts": [
+ {
+ "Path": "path/to/my.nut",
+ "RunOn": "( CLIENT || SERVER ) && MP"
+ },
+ {
+ "Path": "path/to/my_second.nut",
+ "RunOn": "( CLIENT || SERVER ) && MP",
+ "ClientCallback": {
+ "Before": "ClientPreMapspawnThing",
+ "After": "AfterMapspawnClientThing"
+ },
+ "ServerCallback": {
+ "Before": "ServerPreMapspawncrap",
+ "After": "ServerAfterMapspawnWoo"
+ }
+ }
+ ]
+```
+
+>TODO: Create and link Squirrel VM documentation
+
+`"Path"` indicates where the script is, `"RunOn"` is the Squirrel VM context (see [Squirrel VM](#)) as an expression, and `"ClientCallback"` and `"ServerCallback"` specify a function call that can be `"Before"` and/or `"After"` map-spawn. \ No newline at end of file
diff --git a/modding/keyvalues.md b/modding/keyvalues.md
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/modding/keyvalues.md
diff --git a/modding/localisation_files.md b/modding/localisation_files.md
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/modding/localisation_files.md
diff --git a/modding/squirrel/what-is-squirrel.md b/modding/squirrel/what-is-squirrel.md
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/modding/squirrel/what-is-squirrel.md
diff --git a/modding/tutorials/1-first-mod/.gitkeep b/modding/tutorials/1-first-mod/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/modding/tutorials/1-first-mod/.gitkeep
diff --git a/modding/tutorials/2-creating-vscripts/.gitkeep b/modding/tutorials/2-creating-vscripts/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/modding/tutorials/2-creating-vscripts/.gitkeep
diff --git a/modding/tutorials/3-particles-and-vmts/.gitkeep b/modding/tutorials/3-particles-and-vmts/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/modding/tutorials/3-particles-and-vmts/.gitkeep
diff --git a/modding/tutorials/modding-tutorials.md b/modding/tutorials/modding-tutorials.md
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/modding/tutorials/modding-tutorials.md