aboutsummaryrefslogtreecommitdiff
path: root/docs/modding-and-development/development/repositories
diff options
context:
space:
mode:
authorGeckoEidechse <gecko.eidechse+gitbook@protonmail.com>2022-06-16 15:46:36 +0000
committergitbook-bot <ghost@gitbook.com>2022-06-16 15:46:36 +0000
commit1a76b5e319ef7304081fa63a41b82bb976b9c962 (patch)
treef48fe6106e2c7fa856bbd27928b43f40e8daa8cf /docs/modding-and-development/development/repositories
parente08dd64c7930d0e2b9dc0837784f3d03d0151f9c (diff)
downloadNorthstarWiki-1a76b5e319ef7304081fa63a41b82bb976b9c962.tar.gz
NorthstarWiki-1a76b5e319ef7304081fa63a41b82bb976b9c962.zip
GitBook: [#46] Move repo pages to subpage
Diffstat (limited to 'docs/modding-and-development/development/repositories')
-rw-r--r--docs/modding-and-development/development/repositories/README.md3
-rw-r--r--docs/modding-and-development/development/repositories/northstarlauncher.md7
-rw-r--r--docs/modding-and-development/development/repositories/northstarmasterserver/README.md11
-rw-r--r--docs/modding-and-development/development/repositories/northstarmasterserver/deploy.md27
4 files changed, 48 insertions, 0 deletions
diff --git a/docs/modding-and-development/development/repositories/README.md b/docs/modding-and-development/development/repositories/README.md
new file mode 100644
index 0000000..d459d3b
--- /dev/null
+++ b/docs/modding-and-development/development/repositories/README.md
@@ -0,0 +1,3 @@
+# Repositories
+
+The Northstar codebase stretches over multiple repositories, with different repos containing code for different aspects of Northstar. Check sub-pages for a description of some of them.
diff --git a/docs/modding-and-development/development/repositories/northstarlauncher.md b/docs/modding-and-development/development/repositories/northstarlauncher.md
new file mode 100644
index 0000000..89aeca4
--- /dev/null
+++ b/docs/modding-and-development/development/repositories/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/repositories/northstarmasterserver/README.md b/docs/modding-and-development/development/repositories/northstarmasterserver/README.md
new file mode 100644
index 0000000..2b5ac8a
--- /dev/null
+++ b/docs/modding-and-development/development/repositories/northstarmasterserver/README.md
@@ -0,0 +1,11 @@
+# NorthstarMasterServer
+
+## Introduction
+
+The master server is responsible for centralizing game servers created by players, it also verifies that connecting players own an Origin account with Titanfall 2.
+
+There's no need to host your own master server to play games with other people, you can use [direct connect](../../../../installing-northstar/using-northstar/direct-connect.md) or just setup a [normal server](../../../../hosting-a-server-with-northstar/basic-listen-server.md) that announces itself to `northstar.tf`. This tutorial is aimed for those who want to contribute improvements to the code or test their own changes to the project.
+
+## Contents
+
+* [Deploy](deploy.md)
diff --git a/docs/modding-and-development/development/repositories/northstarmasterserver/deploy.md b/docs/modding-and-development/development/repositories/northstarmasterserver/deploy.md
new file mode 100644
index 0000000..e1d5985
--- /dev/null
+++ b/docs/modding-and-development/development/repositories/northstarmasterserver/deploy.md
@@ -0,0 +1,27 @@
+# Deploying Master Server
+
+## Development
+
+A Development Master Server uses http requests, it should be used for development purposes on your local machine.
+
+### Installation steps
+
+1. Clone [NorthstarMasterServer](https://github.com/R2Northstar/NorthstarMasterServer).
+1. Copy the default [dev.env](https://github.com/R2Northstar/NorthstarMasterServer/blob/main/dev.env) to `.env` replace the ip with `127.0.0.1`.
+1. Run `npm install` && `npm run watch`.
+
+Your master server is now running, to connect to it you need to change some configuration files.
+
+Northstar default masterserver is https://northstar.tf, to point to a new location you need to modify this URL in the `autoexec_ns_server.cfg` and `autoexec_ns_client.cfg` config files.
+
+### Enabling HTTPS
+
+HTTPS should be used if you plan for other people to use your master server. It can be enabled pretty easy with [Caddy](https://caddyserver.com/). Download a Caddy binary and create a `Caddyfile` with the following content:
+
+```
+{$SHORTDOMAIN:localhost} {
+ reverse_proxy http://127.0.0.1:8080
+}
+```
+
+After configuring your DNS domain you can run it with `SHORTDOMAIN=example.com caddy run`. Caddy will automatically generate and maintain your certificates for you, check its documentation for more info: https://caddyserver.com/docs/