Move gitbook content to docs/ subdirectory

6 files changed, 129 insertions, 0 deletions

diff --git a/docs/using-northstar/commands.md b/docs/using-northstar/commands.md
new file mode 100644
index 0000000..41fc983
--- /dev/null
+++ b/docs/using-northstar/commands.md
@@ -0,0 +1,36 @@
+# Commands
+
+### Opening the Console
+
+Commands are run on the console. To open it, press `` ` `` (the key above `TAB`).\
+Note that this key generally only exists in this form on English keybords (ANSI US, ISO UK, ...).
+
+If you for example have a German keyboard you'll notice that this key is located left of `BACKSPACE` but won't open the console when you press it.
+
+To open your console you'll either have to switch to the English (US) layout **before** starting the game or rebinding the key to open console.
+
+To rebind it make sure neither Titanfall nor Northstar are running, then go to `My Documents\Respawn\Titanfall2\local\` and open `settings.cfg`.\
+Look for the line containing `toggleconsole`, i.e.
+
+```
+bind "`" "toggleconsole"
+```
+
+and replace the `` ` `` key with your prefered key to open console. So if you want to open console with `F5`, change the line to
+
+```
+bind "F5" "toggleconsole"
+```
+
+{% hint style="info" %}
+In the future this keybind should hopefully be adjustable via `Controls > Settings > Key Binds` from within Titanfall.\
+**Note** that if you're using the [Enhanced Menu Mod](https://github.com/taskinoz/Enhanced-Menu-Mod) this might already be the case
+{% endhint %}
+
+### List of commands
+
+| Command                 | Result         |
+| ----------------------- | -------------- |
+| `sv_cheats 1`           | Enable cheats  |
+| `sv_cheats 0`           | Disable cheats |
+| TODO more commands here |                |
diff --git a/docs/using-northstar/direct-connect.md b/docs/using-northstar/direct-connect.md
new file mode 100644
index 0000000..78e37b5
--- /dev/null
+++ b/docs/using-northstar/direct-connect.md
@@ -0,0 +1,14 @@
+# Direct Connect
+
+If a server is set to private and doesn't show up in the server browser, you can directly connect to it from the console by:
+
+1. [Opening the console](commands.md#opening-the-console).
+2. Typing in `connect <ip address>:<port number>`. The default port is `37015`.
+
+If you are using a normal Titanfall 2 client (Note this will only work on servers with `ns_auth_allow_insecure 1`):
+
+1. Open Origin, click on Titanfall 2 and Click on the settings icon.
+2. Click `Game Properties` and select `Advanced Launch Options`.
+3. Add `+bind "KEY" "connect <ip address>:<port>"`
+4. Open the game and select a single player level e.g The Gauntlet
+5. Press the `KEY` you specified in step 3
diff --git a/docs/using-northstar/gamemodes.md b/docs/using-northstar/gamemodes.md
new file mode 100644
index 0000000..795ebb9
--- /dev/null
+++ b/docs/using-northstar/gamemodes.md
@@ -0,0 +1,24 @@
+# Gamemodes
+## Sandbox
+Like gmod but worse.
+
+## Gun Game
+Get a kill with each gun to win.
+
+## Titan Tag
+Earn points while in your titan. Destroy a titan to get your own.
+
+## Infection
+Survivors are infected when killed.
+
+## Frontier War
+Destroy the enemy's harvester and protect your own.
+
+## Amped Killrace
+Get kills to increase the length of your killrace. Collect the flag to start it. Set the record to win.
+
+## Fastball
+Hack control panels to win rounds and respawn your teammates.
+
+## Competitive CTF
+CTF with custom settings for Comp games.
\ No newline at end of file
diff --git a/docs/using-northstar/mods.md b/docs/using-northstar/mods.md
new file mode 100644
index 0000000..a045314
--- /dev/null
+++ b/docs/using-northstar/mods.md
@@ -0,0 +1,12 @@
+# Mods
+
+![Northstar Mods](https://user-images.githubusercontent.com/7439692/146625579-20586c9e-2e23-4c5d-ba56-27b6eb1ffff4.jpg)
+
+
+## Pre-installed mods:
+
+Northstar by default comes with 3 mods installed. They are located in the `Titanfall2\R2Northstar\mods` folder. You can access these from the `Mods` menu at the bottom of the main menu.
+
+- **Northstar.Client** - Various ui and client changes to fix bugs and add better support for mods
+- **Northstar.Custom** - Additional gamemodes and weapons for the game, such as Fastball, Titan Tag, Infection, and Hide and Seek.
+- **Northstar.CustomServers** - The basic mod for hosting servers with additional match settings
\ No newline at end of file
diff --git a/docs/using-northstar/playing-on-linux.md b/docs/using-northstar/playing-on-linux.md
new file mode 100644
index 0000000..8f3e8d7
--- /dev/null
+++ b/docs/using-northstar/playing-on-linux.md
@@ -0,0 +1,38 @@
+# Playing on Linux
+
+Linux is not officially supported currently. However, you can get it working through Proton or Wine by following this guide.
+
+## Installing Northstar on Steam (Proton)
+
+1. Download the latest version of Northstar from the [releases](https://github.com/R2Northstar/Northstar/releases) page
+2. Extract all contents of the file to your Titanfall 2 folder ( Right click _Titanfall 2_ > Open _Properties_ > Click _Local Files_ > Click _Browse_ )
+3. Rename _Titanfall2.exe_ to anything else ( for example _Titanfall2old.exe_ ), and rename _NorthstarLauncher.exe_ to _Titanfall2.exe_
+
+Now Steam will automatically launch Northstar when you hit play. Just launch the game through Steam and you should be greeted with a Northstar welcome message upon entering the main menu.
+
+> **Note:** There is a current bug where the game would sometimes launch vanilla Titanfall 2 instead of Northstar. There is no universal fix for this, but people have reported changing Proton versions to _Proton 5.13_ or _Proton Experimental_ and deleting the Proton prefix folder (`Steam/steamapps/compatdata/1237970/`) could help resolve this issue
+
+> If you are still suffering from this bug, try running the game through Lutris. The bug doesn't seem to happen there
+
+## Installing Northstar on Lutris (Wine)
+
+1. If you don't already have the game downloaded, install the game [from here.](https://lutris.net/games/titanfall-2/) 
+2. Download the latest version of Northstar from the [releases](https://github.com/R2Northstar/Northstar/releases) page
+3. Extract all contents of the file to your Titanfall 2 folder
+
+4. **If you have the game installed on Lutris:** right click _Titanfall 2_ > _Configure_ > _Game Options_ > Set _Executable path_ to _NorthstarLauncher.exe_
+5. **Otherwise:** click the `+` button in the top left > set the name to whatever and _Runner_ to _Wine_ > click on _Game options_ > set _Executable path_ to _NorthstarLauncher.exe_ then save. 
+
+> **If you're migrating from Steam:** Set _Wine prefix_ to `(your Steam directory)/steamapps/compatdata/1237970/pfx/`. This will save you the hassle of having to re-download Origin. 
+
+Now just launch the game through Lutris and you should be greeted with a Northstar welcome message upon entering the main menu.
+
+> **Note:** Origin might prompt you to log in and "set an installation folder for future downloads" on first launch. Just do those, close Origin, then launch the game again.
+
+> You might feel the game is stuttering a lot in the first hour of playing. This is normal, it's just DXVK is compiling shaders. The more you play, the less you will stutter in the future. Someone on discord wrote [an in-depth guide](https://i.imgur.com/xzop1lQ.png) on good settings to help the shader cache **and a general performance boost by stopping Origin from writing unnecessary files**.\
+> [Link to cache](https://github.com/Cervoxx/DXVKCACHE/raw/master/Titanfall2-cache.tar.xz)\
+> [Link to Origin being slow discussion](https://github.com/ValveSoftware/Proton/issues/4001#issuecomment-647014231)
+
+---
+
+For more info and proposed fixes, refer to [this issue thread on Github](https://github.com/R2Northstar/Northstar/issues/1)
diff --git a/docs/using-northstar/server-browser.md b/docs/using-northstar/server-browser.md
new file mode 100644
index 0000000..de4d59b
--- /dev/null
+++ b/docs/using-northstar/server-browser.md
@@ -0,0 +1,5 @@
+# Server Browser
+
+![Server Browser](https://user-images.githubusercontent.com/7439692/146625598-67d3b54f-f2b6-4ec9-84e8-294e00b3afcc.jpg)
+
+Northstar Comes with a server browser which you can use to connect to community hosted servers. Hovering over a server name will show you what mods the server has enabled and the version of those mods. Each server can be connected to by clicking on its name. You can refresh the list of servers by clicking the `Refresh` button in the bottom corner.
\ No newline at end of file