From a47293ae32ef2e616d18d73f29a753e83f14c395 Mon Sep 17 00:00:00 2001 From: GeckoEidechse Date: Thu, 16 Jun 2022 15:49:40 +0000 Subject: GitBook: [#47] Move Testing page into Development section --- .../development/northstarlauncher.md | 7 +++++ .../development/northstarmasterserver/README.md | 11 ++++++++ .../development/northstarmasterserver/deploy.md | 27 +++++++++++++++++++ .../development/repositories/northstarlauncher.md | 7 ----- .../repositories/northstarmasterserver/README.md | 11 -------- .../repositories/northstarmasterserver/deploy.md | 27 ------------------- .../modding-and-development/development/testing.md | 31 ++++++++++++++++++++++ docs/modding-and-development/testing.md | 31 ---------------------- 8 files changed, 76 insertions(+), 76 deletions(-) create mode 100644 docs/modding-and-development/development/northstarlauncher.md create mode 100644 docs/modding-and-development/development/northstarmasterserver/README.md create mode 100644 docs/modding-and-development/development/northstarmasterserver/deploy.md delete mode 100644 docs/modding-and-development/development/repositories/northstarlauncher.md delete mode 100644 docs/modding-and-development/development/repositories/northstarmasterserver/README.md delete mode 100644 docs/modding-and-development/development/repositories/northstarmasterserver/deploy.md create mode 100644 docs/modding-and-development/development/testing.md delete mode 100644 docs/modding-and-development/testing.md (limited to 'docs/modding-and-development') 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..c6fbadb --- /dev/null +++ b/docs/modding-and-development/development/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/northstarmasterserver/deploy.md b/docs/modding-and-development/development/northstarmasterserver/deploy.md new file mode 100644 index 0000000..c384730 --- /dev/null +++ b/docs/modding-and-development/development/northstarmasterserver/deploy.md @@ -0,0 +1,27 @@ +# Deploy + +## 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). +2. Copy the default [dev.env](https://github.com/R2Northstar/NorthstarMasterServer/blob/main/dev.env) to `.env` replace the ip with `127.0.0.1`. +3. 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/ diff --git a/docs/modding-and-development/development/repositories/northstarlauncher.md b/docs/modding-and-development/development/repositories/northstarlauncher.md deleted file mode 100644 index 89aeca4..0000000 --- a/docs/modding-and-development/development/repositories/northstarlauncher.md +++ /dev/null @@ -1,7 +0,0 @@ -# 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 deleted file mode 100644 index 2b5ac8a..0000000 --- a/docs/modding-and-development/development/repositories/northstarmasterserver/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# 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 deleted file mode 100644 index e1d5985..0000000 --- a/docs/modding-and-development/development/repositories/northstarmasterserver/deploy.md +++ /dev/null @@ -1,27 +0,0 @@ -# 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/ diff --git a/docs/modding-and-development/development/testing.md b/docs/modding-and-development/development/testing.md new file mode 100644 index 0000000..6c237dd --- /dev/null +++ b/docs/modding-and-development/development/testing.md @@ -0,0 +1,31 @@ +--- +description: >- + Instructions regarding testing new features, directed at both developers and + maintainers +--- + +# Testing + +{% hint style="info" %} +This section is very much still WIP. Feel free to help expand it. +{% endhint %} + +## Developers & Contributors + +This section applies to you if you're opening a pull request to any of the Northstar repos. + +Whatever your change includes, whether a bug fix or a new feature make sure to test it appropriately. + +This means if your change is a bug fix, it's recommend you first make sure you can reproduce the bug. Then after making the necessary changes to fix it, test it using the same method you used to originally confirm the bug. \ +When you're opening a pull request, make sure to mention how to reproduce the bug, so that reviewers can confirm that your chance indeed fixed the issue. + +If your change is a new feature, make sure to test both that the newly added functionality performs as expected, as well as ensuring that it doesn't introduce any form of regression bugs. This means, testing anything that might be affected by your new feature. + + +## Maintainers + +This section applies to you if you're someone who's able to merge PRs in any of the repos of the Northstar GitHub org as well as when simplying performing reviews, even without being able to actually merge a PR. + +When reviewing pull requests on GitHub, make sure to checkout the changes made by a PR locally and test it there. In particular, test the parts of the code that are touched by a PR. + +After testing, make sure to mention the steps tested in your review. diff --git a/docs/modding-and-development/testing.md b/docs/modding-and-development/testing.md deleted file mode 100644 index 6c237dd..0000000 --- a/docs/modding-and-development/testing.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -description: >- - Instructions regarding testing new features, directed at both developers and - maintainers ---- - -# Testing - -{% hint style="info" %} -This section is very much still WIP. Feel free to help expand it. -{% endhint %} - -## Developers & Contributors - -This section applies to you if you're opening a pull request to any of the Northstar repos. - -Whatever your change includes, whether a bug fix or a new feature make sure to test it appropriately. - -This means if your change is a bug fix, it's recommend you first make sure you can reproduce the bug. Then after making the necessary changes to fix it, test it using the same method you used to originally confirm the bug. \ -When you're opening a pull request, make sure to mention how to reproduce the bug, so that reviewers can confirm that your chance indeed fixed the issue. - -If your change is a new feature, make sure to test both that the newly added functionality performs as expected, as well as ensuring that it doesn't introduce any form of regression bugs. This means, testing anything that might be affected by your new feature. - - -## Maintainers - -This section applies to you if you're someone who's able to merge PRs in any of the repos of the Northstar GitHub org as well as when simplying performing reviews, even without being able to actually merge a PR. - -When reviewing pull requests on GitHub, make sure to checkout the changes made by a PR locally and test it there. In particular, test the parts of the code that are touched by a PR. - -After testing, make sure to mention the steps tested in your review. -- cgit v1.2.3