Merge branch 'wiki-main'

.gitbook.yaml

@@ -0,0 +1,5 @@
+root: ./docs/
+
+structure:
+    readme: README.md
+    summary: SUMMARY.md

.github/.markdownlinkcheck.json

@@ -14,6 +14,21 @@
         },
         {
             "pattern": "/_static/corner_test_map.map"
+        },
+        {
+            "pattern": "https://help.ea.com/en/help/pc/link-ea-and-steam/"
+        },
+        {
+            "pattern": "https://panel.ticketsbot.net/manage/920776187884732556/tags"
+        },
+        {
+            "pattern": "https://forum.manjaro.org/t/howto-troubleshoot-crackling-in-pipewire/82442"
+        },
+        {
+            "pattern": "https://taskinoz.com/northstar/"
+        },
+        {
+            "pattern": "https://wiki.archlinux.org/title/PulseAudio/Troubleshooting#Glitches.2C\\_skips\\_or\\_crackling"
         }
     ]
 }

.github/pull_request_template.md

@@ -0,0 +1,8 @@
+<!-- 
+BEFORE OPENING A PULL REQUEST:
+-> If you're adding multiple independent changes (e.g. adding a section about modding while also fixing a typo on another page) it's generally recommended to split these changes into separate pull requests.
+
+Note that pull requests containing lots of unhelpful commit messages will generally be squashed to keep commit history clean.
+-->
+
+Replace this line with a short description of your change.

.gitignore

@@ -157,4 +157,7 @@ cython_debug/
 
 # repo specific stuff
 .vscode
-docs/source/_build
+docs/source/_build
+
+# mdbook related folder
+book

CODE_OF_CONDUCT.md

@@ -0,0 +1,124 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement [here](https://github.com/R2Northstar).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available [here](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ [here](https://www.contributor-covenant.org/faq). Translations are available [here](https://www.contributor-covenant.org/translations).

CONTRIBUTING.md

@@ -0,0 +1,12 @@
+# Contributing
+
+In case you feel like something is out of place, not accurate, biased, or if you just want to contribute, please [open a new issue](https://github.com/R2Northstar/NorthstarWiki/issues/) or [make a pull request](https://github.com/R2Northstar/NorthstarWiki/pulls) to our wiki:\
+[https://github.com/R2Northstar/NorthstarWiki](https://github.com/R2Northstar/NorthstarWiki)
+
+## Contacting us
+
+You are welcome to create an issue at:\
+[https://github.com/R2Northstar/NorthstarWiki/issues](https://github.com/R2Northstar/NorthstarWiki/issues)
+
+Alternatively feel free to reach out via Discord:\
+[https://northstar.tf/discord](https://northstar.tf/discord)

book.toml

@@ -0,0 +1,13 @@
+# This file configures `mdbook` which is used for rendering wiki locally
+# See the main README.md for more info
+
+[book]
+language = "en"
+multilingual = false
+src = "docs"
+title = "Northstar Wiki"
+
+[output.html]
+
+[output.linkcheck]
+optional = true

docs/Wiki/README.md

@@ -0,0 +1,43 @@
+---
+coverY: 0
+description: A Titanfall|2 mod to join and host custom servers.
+cover: images/northstarbanner.png
+---
+
+# Welcome to Northstar
+
+{% embed url="https://www.youtube.com/watch?v=en06Y6CPMQg" %}
+
+## Releases and installation guide
+
+Get the newest Northstar release here:
+
+{% embed url="https://github.com/R2Northstar/Northstar/releases" %}
+
+Install instructions can be found here:
+
+{% content-ref url="installing-northstar/basic-setup.md" %}
+[basic-setup.md](installing-northstar/basic-setup.md)
+{% endcontent-ref %}
+
+## Modding instructions
+
+For modding guides, documentation on Northstar API features and documentation on Respawn Squirrel look at:
+
+{% embed url="https://docs.northstar.tf/Modding/" %}
+
+## Contact and contributing
+
+**Please remember:** You should expect to encounter bugs and crashes with Northstar.\
+If you need help troubleshooting, setting up or modifying Northstar try talking to the community on our Discord server:
+{% embed url="https://northstar.tf/discord" %}
+
+Before creating issues or contributing changes to the source code please read:
+
+{% content-ref url="contributing.md" %}
+[contributing.md](contributing.md)
+{% endcontent-ref %}
+
+All the source code related to Northstar can be found here:
+
+{% embed url="https://northstar.tf" %}

docs/Wiki/SUMMARY.md

@@ -0,0 +1,74 @@
+# Table of contents
+
+* [Welcome to Northstar](README.md)
+* [Contributing](contributing.md)
+
+## Installing Northstar
+
+* [Basic Setup](installing-northstar/basic-setup.md)
+* [Northstar Installers](installing-northstar/northstar-installers/README.md)
+  * [FlightCore Guide](installing-northstar/northstar-installers/flightcore-guide.md)
+  * [VTOL Guide](installing-northstar/northstar-installers/vtol-guide.md)
+  * [Viper Guide](installing-northstar/northstar-installers/viper-guide.md)
+* [Manual installation](installing-northstar/manual-installation.md)
+* [SteamDeck and Linux](steamdeck-and-linux/README.md)
+  * [Installing on SteamDeck and Linux](steamdeck-and-linux/installing-on-steamdeck-and-linux.md)
+  * [Troubleshooting](steamdeck-and-linux/linux-troubleshooting.md)
+* [Troubleshooting](installing-northstar/troubleshooting.md)
+
+***
+
+* [Using Northstar](using-northstar/README.md)
+  * [Mods](using-northstar/mods.md)
+  * [Packages](using-northstar/packages.md)
+  * [Server Browser](using-northstar/server-browser.md)
+  * [Direct Connect](using-northstar/direct-connect.md)
+  * [Gamemodes](using-northstar/gamemodes.md)
+  * [Commands](using-northstar/commands.md)
+  * [Launch arguments](using-northstar/launch-arguments.md)
+  * [Progression System](using-northstar/progression.md)
+  * [Vanilla via Northstar](using-northstar/vanilla.md)
+  * [Advanced](using-northstar/advanced.md)
+* [FAQ](faq.md)
+
+## Hosting a server with Northstar
+
+* [Getting started](hosting-a-server-with-northstar/getting-started.md)
+* [Hosting a Basic Listen Server](hosting-a-server-with-northstar/basic-listen-server.md)
+* [Hosting a Dedicated Server](hosting-a-server-with-northstar/dedicated-server/README.md)
+  * [Best practices](hosting-a-server-with-northstar/dedicated-server/best-practices.md)
+  * [Hosting on Windows](hosting-a-server-with-northstar/dedicated-server/hosting-on-windows.md)
+  * [Hosting on Linux](hosting-a-server-with-northstar/dedicated-server/hosting-on-linux.md)
+* [Hosting a Local-only Server](hosting-a-server-with-northstar/local-only-server.md)
+* [Server settings](hosting-a-server-with-northstar/server-settings/README.md)
+  * [Startup arguments](hosting-a-server-with-northstar/server-settings/startup-args.md)
+  * [ConVars](hosting-a-server-with-northstar/server-settings/convars.md)
+  * [Playlistvars](hosting-a-server-with-northstar/server-settings/playlistvar.md)
+  * [Name in the files](hosting-a-server-with-northstar/server-settings/file-names.md)
+  * [Banlist](hosting-a-server-with-northstar/server-settings/banlist.md)
+* [Troubleshooting](hosting-a-server-with-northstar/troubleshooting.md)
+
+## Modding and Development
+
+* [Modding](modding/README.md)
+* [Development](development/README.md)
+  * [Repositories](development/repositories/README.md)
+    * [Atlas](development/repositories/atlas.md)
+    * [NorthstarMods](development/repositories/northstarmods.md)
+    * [NorthstarLauncher](development/repositories/northstarlauncher.md)
+    * [NorthstarMasterServer (old)](development/northstarmasterserver/README.md)
+      * [Deploy](development/northstarmasterserver/deploy.md)
+  * [Contributing code to Northstar](development/contributing-code-to-northstar.md)
+  * [Testing](development/testing.md)
+  * [Reviewing](development/reviewing.md)
+  * [Releases](development/releases.md)
+  * [Debugging](development/debugging/README.md)
+    * [Visual Studio](development/debugging/visualstudio.md)
+    * [x64dbg](development/debugging/x64dbg.md)
+
+## Other
+
+* [Helping](other/helping.md)
+* [Discord moderation](other/moderation/README.md)
+  * [Rules](other/moderation/rules.md)
+* [Credits](other/credits.md)

docs/Wiki/contributing.md

@@ -0,0 +1,15 @@
+---
+description: Contribution guidelines
+---
+
+# Contributing
+
+## Creating an issue <a href="#contributing" id="contributing"></a>
+
+Read [CONTRIBUTING.md](https://github.com/R2Northstar/Northstar/blob/main/CONTRIBUTING.md) before creating an issue, if you believe that the issue is valid fill the provided template with the requested info.
+
+{% hint style="info" %}
+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/README.md) section if you are unsure of where to open a ticket.

docs/Wiki/development/README.md

@@ -0,0 +1,17 @@
+---
+description: >-
+  Instructions on how to make changes to Northstar source code, build, and run
+  it.
+---
+
+# Development
+
+Check the subpages on the sidebar for various aspects of Northstar development.
+
+## Repositories
+
+Check the following page for information about different code repositories Northstar uses
+
+{% content-ref url="repositories/" %}
+[repositories](repositories/)
+{% endcontent-ref %}