aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/.gitbook/assets/vtol-main-window.pngbin0 -> 541193 bytes
-rw-r--r--docs/SUMMARY.md1
-rw-r--r--docs/installing-northstar/basic-setup.md9
-rw-r--r--docs/installing-northstar/northstar-installers.md32
-rw-r--r--docs/modding-and-development/development/repos.md2
-rw-r--r--docs/steamdeck-and-linux/installing-on-steamdeck-and-linux.md11
-rw-r--r--docs/steamdeck-and-linux/playing-on-linux-legacy-guide.md10
7 files changed, 31 insertions, 34 deletions
diff --git a/docs/.gitbook/assets/vtol-main-window.png b/docs/.gitbook/assets/vtol-main-window.png
new file mode 100644
index 0000000..ffe85e3
--- /dev/null
+++ b/docs/.gitbook/assets/vtol-main-window.png
Binary files differ
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index c67e668..d750b7b 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -41,6 +41,7 @@
* [Modding](modding/README.md)
* [Development](modding-and-development/development/README.md)
+ * [Repos](modding-and-development/development/repos.md)
* [Repositories](modding-and-development/development/repositories/README.md)
* [Atlas](modding-and-development/development/repositories/atlas.md)
* [NorthstarMods](modding-and-development/development/repositories/northstarmods.md)
diff --git a/docs/installing-northstar/basic-setup.md b/docs/installing-northstar/basic-setup.md
index 108078c..5d8b6d6 100644
--- a/docs/installing-northstar/basic-setup.md
+++ b/docs/installing-northstar/basic-setup.md
@@ -8,7 +8,6 @@ Head over to the installer page and pick one of the existing installers. All of
[northstar-installers.md](northstar-installers.md)
{% endcontent-ref %}
-
## Manual installation
If you prefer to avoid any additional installers and know what you're doing, check out the guide for manual installation:
@@ -33,14 +32,12 @@ If Northstar doesn't appear to be installed, or you have issues entering the lob
Northstar can be launched through Steam or Origin using the "add a game" feature. This allows you to register any .exe as a game. To set up Northstar, navigate to your Titanfall 2 folder and choose `NorthstarLaucher.exe`.
-![steamaddgame](/docs/images/steam-addgame.png) ![originaddgame](/docs/images/origin-addgame.png)
-
-
+![steamaddgame](../images/steam-addgame.png) ![originaddgame](../images/origin-addgame.png)
## Linux
-Install instructions for [Linux can be found here](using-northstar/playing-on-linux.md).
+Install instructions for [Linux can be found here](broken-reference).
## SteamDeck
-Install instructions for [SteamDeck can be found here](using-northstar/playing-on-linux.md#steamdeck).
+Install instructions for [SteamDeck can be found here](broken-reference).
diff --git a/docs/installing-northstar/northstar-installers.md b/docs/installing-northstar/northstar-installers.md
index ac82a14..ed91c61 100644
--- a/docs/installing-northstar/northstar-installers.md
+++ b/docs/installing-northstar/northstar-installers.md
@@ -5,21 +5,21 @@ Since the public release of Northstar, the wider community has created tools to
Each of these installers covers a different use case. Use the table below to find out which one suits you best:
| Features | r2mm | Viper | VTOL | Papa |
-| ------------------------------- | ---- | ----- | ---- |------|
-| Install Northstar | ✔️ | ✔️ | ✔️ | ✔️ |
-| Update Northstar | ✔️ | ✔️ | ✔️ | ✔️ |
-| Launch Northstar | ✔️ | ✔️ | ✔️ | ❌ |
-| Launch Vanilla | ✔️ | ✔️ | ✔️ | ❌ |
-| Install Mods from Thunderstore | ✔️ | ✔️ | ✔️ | ✔️ |
-| Update Mods | ✔️ | ✔️ | ✔️ | ✔️ |
-| | | | | |
-| Set launch arguments | ❓ | ✔️ | ✔️ | ❌ |
-| Installing mods for other games | ✔️ | ❌ | ❌ | ❌ |
-| Install skins | ❓ | ❌ | ✔️ | ❌ |
-| Linux support | ❓ | ✔️ | ❌ | ✔️ |
-| Install Mods from GitHub/GitLab | ❌ | ❌ | ✔️ | ❌ |
-| Server config creator | ❌ | ❌ | ✔️ | ❌ |
-| Package mods for Thunderstore | ❌ | ❌ | ✔️ | ❌ |
+| ------------------------------- | ---- | ----- | ---- | ---- |
+| Install Northstar | ✔️ | ✔️ | ✔️ | ✔️ |
+| Update Northstar | ✔️ | ✔️ | ✔️ | ✔️ |
+| Launch Northstar | ✔️ | ✔️ | ✔️ | ❌ |
+| Launch Vanilla | ✔️ | ✔️ | ✔️ | ❌ |
+| Install Mods from Thunderstore | ✔️ | ✔️ | ✔️ | ✔️ |
+| Update Mods | ✔️ | ✔️ | ✔️ | ✔️ |
+| | | | | |
+| Set launch arguments | ❓ | ✔️ | ✔️ | ❌ |
+| Installing mods for other games | ✔️ | ❌ | ❌ | ❌ |
+| Install skins | ❓ | ❌ | ✔️ | ❌ |
+| Linux support | ❓ | ✔️ | ❌ | ✔️ |
+| Install Mods from GitHub/GitLab | ❌ | ❌ | ✔️ | ❌ |
+| Server config creator | ❌ | ❌ | ✔️ | ❌ |
+| Package mods for Thunderstore | ❌ | ❌ | ✔️ | ❌ |
Note that none of these tools are directly part of the Northstar project and as such any issues with them should be reported to the respective authors instead.
@@ -62,7 +62,7 @@ Download and source code:
## **BigSpice:** VTOL
-![vtol](../images/vtol-main-window.png)
+![vtol](../.gitbook/assets/vtol-main-window.png)
Easy to use and extensive Northstar installer and mod-manager. Supports installing from Thunderstore as well as from outside sources like GitHub/GitLab repositories. Has support for installing custom weapon/pilot skins. Features manager for setting up dedicated servers.
diff --git a/docs/modding-and-development/development/repos.md b/docs/modding-and-development/development/repos.md
new file mode 100644
index 0000000..0b9cac8
--- /dev/null
+++ b/docs/modding-and-development/development/repos.md
@@ -0,0 +1,2 @@
+# Repos
+
diff --git a/docs/steamdeck-and-linux/installing-on-steamdeck-and-linux.md b/docs/steamdeck-and-linux/installing-on-steamdeck-and-linux.md
index 21708ce..33f4a18 100644
--- a/docs/steamdeck-and-linux/installing-on-steamdeck-and-linux.md
+++ b/docs/steamdeck-and-linux/installing-on-steamdeck-and-linux.md
@@ -16,14 +16,11 @@ On Steam Deck, complete the following in desktop mode. You may return to game mo
2. Then extract all contents of the file to your Titanfall 2 folder ( Right click _Titanfall 2_ > Open _Properties_ > Click _Local Files_ > Click _Browse_ )
3. In your Titanfall2 folder create a file called `run_northstar.txt` and write a single `1` to it, i.e. `echo 1 > run_northstar.txt`
4. Install NorthstarProton
- 1. **Protonup-QT**: Click *About*, then tick the box to enable *advanced mode*. You should be able to select and install NorthstarProton from the *Add version* menu.
+ 1. **Protonup-QT**: Click _About_, then tick the box to enable _advanced mode_. You should be able to select and install NorthstarProton from the _Add version_ menu.
2. **ProtonPlus**: NorthstarProton can also be installed via ProtonPlus.
- 3. **Manual**: Download the latest release of [NorthstarProton](https://github.com/cyrv6737/NorthstarProton/releases/), extract it, and place the folder in one of the following directories:
-
-> **Steam (Native Package) & Steam Deck:** `~/.local/share/Steam/compatibilitytools.d`
-
-> **Steam (Flatpak):** `~/.var/app/com.valvesoftware.Steam/data/Steam/compatibilitytools.d/`
-
+ 3. **Manual**: Download the latest release of [NorthstarProton](https://github.com/cyrv6737/NorthstarProton/releases/), extract it, and place the folder in one of the following directories:\
+ **Steam (Native Package) & Steam Deck:** `~/.local/share/Steam/compatibilitytools.d`\
+ ``**Steam (Flatpak):** `~/.var/app/com.valvesoftware.Steam/data/Steam/compatibilitytools.d/`
5. Restart Steam. Head to `Properties -> Compatibility` under Titanfall2. Check `Force the use of a specific Steam Play compatibility tool` checkbox, then set the Steam Play compatibility tool to NorthstarProton.
6. Launch Titanfall2, it should now launch Northstar
diff --git a/docs/steamdeck-and-linux/playing-on-linux-legacy-guide.md b/docs/steamdeck-and-linux/playing-on-linux-legacy-guide.md
index 64ea034..e4175b5 100644
--- a/docs/steamdeck-and-linux/playing-on-linux-legacy-guide.md
+++ b/docs/steamdeck-and-linux/playing-on-linux-legacy-guide.md
@@ -1,4 +1,4 @@
-# Playing on Linux (Legacy guide for Northstar 1.9.1 and older)
+# Legacy Linux Guide for 1.9.1 and older
Northstar is officially supported on Linux, it uses compatibility layers like Proton or Wine to launch the game on POSIX systems.
@@ -11,10 +11,10 @@ This guide is new, based on recent information, as such any feedback on success
{% endhint %}
1. Make sure you ran the vanilla version of Titanfall2 at least once on Linux!
-2. Install the latest version of Northstar using [Viper](../northstar-installers.md#0negal-viper) or do it manually
+2. Install the latest version of Northstar using [Viper](../installing-northstar/northstar-installers.md#0negal-viper) or do it manually
1. For manual install download the latest version of Northstar from the [releases](https://github.com/R2Northstar/Northstar/releases) page
2. Then extract all contents of the file to your Titanfall 2 folder ( Right click _Titanfall 2_ > Open _Properties_ > Click _Local Files_ > Click _Browse_ )
-3. In your Titanfall2 folder create a file called `run_northstar.txt` and write a single `1` to it, i.e. `echo 1 > run_northstar.txt` 
+3. In your Titanfall2 folder create a file called `run_northstar.txt` and write a single `1` to it, i.e. `echo 1 > run_northstar.txt`
4. In Steam, set the launch arguments for Titanfall2 to `WINEDLLOVERRIDES="wsock32=n,b" %command%`
5. Install `Proton-7.3-GE-1` (not `GE-Proton7-3`) and select it as the desired Proton version for Titanfall2
6. Launch Titanfall2, it should now launch Northstar
@@ -58,9 +58,9 @@ This guide assumes you own Titanfall2 on Steam and run it from there. If you onl
* Install Titanfall2 via the Steam store on the SteamDeck and run the vanilla game at least once!
* Switch to desktop mode\
(A mouse + keyboard plugged into the Deck are recommended for the next few steps for easier navigation of menus)
-* To install Northstar, grab the Viper launcher from the Discover Store and launch it. It will auto-detect your Titanfall2 install location and install Northstar to it. \
+* To install Northstar, grab the Viper launcher from the Discover Store and launch it. It will auto-detect your Titanfall2 install location and install Northstar to it.\
Alternatively you can manually install Northstar by grabbing the newest zip from [the releases page on GitHub](https://github.com/R2Northstar/Northstar/releases) and extracting the contents to your Titanfall2 folder.
-* Regardless which method you used to install Northstar, now go to your Titanfall2 folder. \
+* Regardless which method you used to install Northstar, now go to your Titanfall2 folder.\
If you installed Titanfall2 on the Deck's internal storage, it will be located at `/home/deck/.local/share/Steam/steamapps/common/Titanfall2`
* Create an empty file called `run_northstar.txt` inside your Titanfall2 folder, open it, and change its content to a single `1`.