From 3e71452634bf0b0a984926a8b534b3c699dbe68f Mon Sep 17 00:00:00 2001 From: GeckoEidechse Date: Sat, 19 Feb 2022 16:50:56 +0000 Subject: GitBook: [#43] Add subpages for development --- docs/SUMMARY.md | 5 +++- docs/contributing.md | 2 +- docs/development.md | 28 ---------------------- docs/modding-and-development/development/README.md | 23 ++++++++++++++++++ .../development/northstarlauncher.md | 7 ++++++ .../development/northstarmasterserver/README.md | 3 +++ .../development/northstarmasterserver/deploy.md | 3 +++ 7 files changed, 41 insertions(+), 30 deletions(-) delete mode 100644 docs/development.md create mode 100644 docs/modding-and-development/development/README.md 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 diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index d321228..6a9c09c 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -54,7 +54,10 @@ * [Setup Syntax Highlighting](modding/squirrel/setup-syntax-highlighting.md) * [Localisation](modding/localisation\_files.md) * [Publishing](modding/publishing.md) -* [Development](development.md) +* [Development](modding-and-development/development/README.md) + * [NorthstarLauncher](modding-and-development/development/northstarlauncher.md) + * [NorthstarMasterServer](modding-and-development/development/northstarmasterserver/README.md) + * [Deploy](modding-and-development/development/northstarmasterserver/deploy.md) ## Other diff --git a/docs/contributing.md b/docs/contributing.md index 55f38fc..26c4730 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -12,4 +12,4 @@ Read [CONTRIBUTING.md](https://github.com/R2Northstar/Northstar/blob/main/CONTRI Please remember that issues created in the Northstar repositories should be related to the mod, avoid creating issues asking for tech support or problems unrelated to the project. {% endhint %} -Check the [Development](development.md) section if you are unsure of where to open a ticket. +Check the [Development](modding-and-development/development/) section if you are unsure of where to open a ticket. diff --git a/docs/development.md b/docs/development.md deleted file mode 100644 index 11f2e9b..0000000 --- a/docs/development.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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](development.md#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. - -## 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/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 -- cgit v1.2.3