aboutsummaryrefslogtreecommitdiff
path: root/docs/modding-and-development/development/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/modding-and-development/development/README.md')
-rw-r--r--docs/modding-and-development/development/README.md23
1 files changed, 23 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.
+