aboutsummaryrefslogtreecommitdiff
path: root/modding/getting-started.md
diff options
context:
space:
mode:
authorGeckoEidechse <gecko.eidechse+gitbook@protonmail.com>2021-12-29 00:00:44 +0000
committergitbook-bot <ghost@gitbook.com>2021-12-29 00:00:44 +0000
commit7b8bd8fe5b164a2f8383bd9900788006fdaa13cc (patch)
tree17d62c3972e0adb2ad33f0cd91c78893e73c1160 /modding/getting-started.md
parente7df10e93e6ca598887fdf95a12d4ae32fb6cd54 (diff)
downloadNorthstarWiki-7b8bd8fe5b164a2f8383bd9900788006fdaa13cc.tar.gz
NorthstarWiki-7b8bd8fe5b164a2f8383bd9900788006fdaa13cc.zip
GitBook: [#10] Fix page link
Diffstat (limited to 'modding/getting-started.md')
-rw-r--r--modding/getting-started.md23
1 files changed, 13 insertions, 10 deletions
diff --git a/modding/getting-started.md b/modding/getting-started.md
index b9ee1f5..17f50aa 100644
--- a/modding/getting-started.md
+++ b/modding/getting-started.md
@@ -1,27 +1,30 @@
-# Getting Started with Modding
+# 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
+
+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 %}
+{% content-ref url="tutorials/modding-tutorials.md" %}
+[modding-tutorials.md](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)
+Provided is a template `mod.json`, for a detailed list of values read [Cheatsheet](cheatsheet.md)
```json
{
@@ -35,7 +38,7 @@ Provided is a template `mod.json`, for a detailed list of values read [Cheatshee
}
```
-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:
+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": [
@@ -58,6 +61,6 @@ Inside the `mod` folder, existing files found in the engine's virtual file syste
]
```
->TODO: Create and link Squirrel VM documentation
+> 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
+`"Path"` indicates where the script is, `"RunOn"` is the Squirrel VM context (see [Squirrel VM](getting-started.md)) as an expression, and `"ClientCallback"` and `"ServerCallback"` specify a function call that can be `"Before"` and/or `"After"` map-spawn.