aboutsummaryrefslogtreecommitdiff
path: root/docs/modding-and-development/development
diff options
context:
space:
mode:
Diffstat (limited to 'docs/modding-and-development/development')
-rw-r--r--docs/modding-and-development/development/README.md23
-rw-r--r--docs/modding-and-development/development/northstarlauncher.md7
-rw-r--r--docs/modding-and-development/development/northstarmasterserver/README.md3
-rw-r--r--docs/modding-and-development/development/northstarmasterserver/deploy.md3
4 files changed, 36 insertions, 0 deletions
diff --git a/docs/modding-and-development/development/README.md b/docs/modding-and-development/development/README.md
new file mode 100644
index 0000000..2df9d7b
--- /dev/null
+++ b/docs/modding-and-development/development/README.md
@@ -0,0 +1,23 @@
+---
+description: >-
+ Instructions on how to make changes to Northstar source code, build, and run
+ it.
+---
+
+# Development
+
+## Repositories
+
+Northstar is split over multiple git repositories that fulfill different functions.
+
+* [Northstar](./#repositories):\
+ Contains compiled and packaged releases
+* [NorthstarLauncher](https://github.com/R2Northstar/NorthstarLauncher):\
+ Contains the source for the launcher used to modify the Titanfall|2 install to allow mods to be loaded.
+* [NorthstarMods](https://github.com/R2Northstar/NorthstarMods):\
+ Contains the standard mods shipped with Northstar to allow joining and hosting custom servers.
+* [NorthstarMasterServer](https://github.com/R2Northstar/NorthstarMasterServer):\
+ Contains the source for the master server used to authenticate clients, display the server browser list, and connect clients to community hosted servers.
+* [NorthstarWiki](https://github.com/R2Northstar/NorthstarWiki):\
+ The repository for this wiki.
+
diff --git a/docs/modding-and-development/development/northstarlauncher.md b/docs/modding-and-development/development/northstarlauncher.md
new file mode 100644
index 0000000..89aeca4
--- /dev/null
+++ b/docs/modding-and-development/development/northstarlauncher.md
@@ -0,0 +1,7 @@
+# NorthstarLauncher
+
+### Setup
+
+Build instructions for the launcher can be found here:
+
+{% embed url="https://github.com/R2Northstar/NorthstarLauncher/blob/main/BUILD.md" %}
diff --git a/docs/modding-and-development/development/northstarmasterserver/README.md b/docs/modding-and-development/development/northstarmasterserver/README.md
new file mode 100644
index 0000000..a647fea
--- /dev/null
+++ b/docs/modding-and-development/development/northstarmasterserver/README.md
@@ -0,0 +1,3 @@
+# NorthstarMasterServer
+
+TODO
diff --git a/docs/modding-and-development/development/northstarmasterserver/deploy.md b/docs/modding-and-development/development/northstarmasterserver/deploy.md
new file mode 100644
index 0000000..c01ea79
--- /dev/null
+++ b/docs/modding-and-development/development/northstarmasterserver/deploy.md
@@ -0,0 +1,3 @@
+# Deploy
+
+TODO