aboutsummaryrefslogtreecommitdiff
path: root/docs/modding/getting-started.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/modding/getting-started.md')
-rw-r--r--docs/modding/getting-started.md64
1 files changed, 0 insertions, 64 deletions
diff --git a/docs/modding/getting-started.md b/docs/modding/getting-started.md
deleted file mode 100644
index 248cf07..0000000
--- a/docs/modding/getting-started.md
+++ /dev/null
@@ -1,64 +0,0 @@
-# Getting Started
-
-## 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="/docs/modding/tutorials/modding-tutorials.md" %}
-[modding-tutorials.md](/docs/modding/tutorials/modding-tutorials.md)
-{% endcontent-ref %}
-
-You can check out all the tools for modding Titanfall 2 here:
-
-{% content-ref url="/docs/modding/tools.md" %}
-[tools.md](/docs/modding/tools.md)
-{% endcontent-ref %}
-
-## 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": "Yourname.Modname",
- "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/file.nut",
- "RunOn": "( CLIENT || SERVER ) && MP"
- },
- {
- "Path": "path/to/another_file.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](modding/getting-started.md)) as an expression, and `"ClientCallback"` and `"ServerCallback"` specify a function call that can be `"Before"` and/or `"After"` map-spawn.