From dcb20303a1df9ee7839d6290a3fb5a4a002c4530 Mon Sep 17 00:00:00 2001 From: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> Date: Fri, 4 Oct 2024 14:41:25 +0200 Subject: [PATCH 1/4] Change mentions of the Spectre bot to Reaper (#102) as it has since been forked and renamed. --- docs/Wiki/other/helping.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/Wiki/other/helping.md b/docs/Wiki/other/helping.md index b096af7d..66aaf49b 100644 --- a/docs/Wiki/other/helping.md +++ b/docs/Wiki/other/helping.md @@ -86,7 +86,7 @@ The bot also provides an online log of the entire ticket connected to the embed A Discord bot created by birb and rewritten by H0L0 which allows you to run commands like `.status` and see how many people are currently online on Northstar, as well as commands such as `.search region aus` (which would search for Northstar servers with the region set to Australia). You can check the [GitHub repo](https://github.com/hummusbird/northstar-bot) for more info on Northstar Servers. -### Spectre +### Reaper -A Discord bot created by Cyn with help from multiple people designed to automatically reply to specific errors messages, screenshots of error messages, and some more quality of life features for helpers. -You can check the [GitHub repo](https://github.com/itscynxx/Spectre) for more info on Spectre. +A Discord bot originally created by Cyn and forked by Gecko, designed to automatically reply to specific errors messages, screenshots of error messages, and some more quality of life features for helpers. +You can check the [GitHub repo](https://github.com/R2NorthstarTools/Reaper) for more info on Reaper. From d86b4df5814006a466d8034bcb47a16342eb5c22 Mon Sep 17 00:00:00 2001 From: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> Date: Fri, 4 Oct 2024 16:32:55 +0200 Subject: [PATCH 2/4] Adjust README for combined docs (#105) by making the title not ModdingDocs specific and explaining the partitioning between Wiki and Modding sections. --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 45aca7ce..723b1351 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ -Titanfall 2 + Northstar Modding Docs +NorthstarDocs ==================================== -This repo contains documentation and guides on most things you need to know about creating mods for Northstar. +This repo contains documentation and guides on most things you need to know about using and creating mods for Northstar. + +It is partitioned into: +- the **Wiki** section which contains a variety of information on how to install and use Northstar as well as troubleshooting tips. +- the **Modding** section which contains all the information necessary to create mods for Northstar as well as further technical details for developing for Northstar. Especially the technical documentation is not done yet and might be incorrect or outdated in some places. From 755e6c95933a0eddb66fd640e9fd779eb51c44ae Mon Sep 17 00:00:00 2001 From: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> Date: Fri, 4 Oct 2024 17:16:23 +0200 Subject: [PATCH 3/4] Use common markdown syntax for formatting headers (#107) in main README --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 723b1351..bb6b2bd9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -NorthstarDocs -==================================== +# NorthstarDocs This repo contains documentation and guides on most things you need to know about using and creating mods for Northstar. @@ -11,8 +10,7 @@ Especially the technical documentation is not done yet and might be incorrect or If you have some knowledge to share, but don't want to write a PR, you can make an issue explaining what you know and we can try to integrate that into the docs. -Contributing ------------- +## Contributing The only prerequisites are python and pip. On Linux simply run `run.sh` in the root dir and in windows execute `run.ps1` with powershell in the root dir. You may need to change the Powershell execution policies in order to run the script. From ed6596ac1575f9710c1a6f7ede0cfa54cb729dfb Mon Sep 17 00:00:00 2001 From: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> Date: Fri, 4 Oct 2024 17:23:44 +0200 Subject: [PATCH 4/4] Mention fix for building on Windows (#108) --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index bb6b2bd9..0f7768a7 100644 --- a/README.md +++ b/README.md @@ -16,3 +16,5 @@ The only prerequisites are python and pip. On Linux simply run `run.sh` in the r Running the script will install all dependencies required and build the docs locally. The local version is available at [port 8000](http://127.0.0.1:8000/). The server will get opened in your browser when the script finishes. When you change a file the server will automatically rebuild it and refresh your browser window. + +If you get an error message while running the script on Windows, check the following GitHub issue: https://github.com/R2Northstar/NorthstarDocs/issues/106