aboutsummaryrefslogtreecommitdiff
path: root/docs/installing-northstar
diff options
context:
space:
mode:
Diffstat (limited to 'docs/installing-northstar')
-rw-r--r--docs/installing-northstar/basic-setup.md6
-rw-r--r--docs/installing-northstar/using-northstar/commands.md7
-rw-r--r--docs/installing-northstar/using-northstar/gamemodes.md2
-rw-r--r--docs/installing-northstar/using-northstar/mods.md7
-rw-r--r--docs/installing-northstar/using-northstar/playing-on-linux.md15
5 files changed, 19 insertions, 18 deletions
diff --git a/docs/installing-northstar/basic-setup.md b/docs/installing-northstar/basic-setup.md
index 753cfdb..d82f493 100644
--- a/docs/installing-northstar/basic-setup.md
+++ b/docs/installing-northstar/basic-setup.md
@@ -18,11 +18,11 @@ Firstly, note that the Northstar client is only available on PC and requires you
Usually: `C:\Program Files\EA Games\Titanfall2`
3. Launch `NorthstarLauncher.exe` to start Northstar
* After launching for the first time, you'll be greeted with a popup requesting to authenticate to the master server. Click _Yes_ (This can be changed in the mods menu later if desired)\
- ![](https://raw.githubusercontent.com/R2Northstar/NorthstarWiki/main/docs/images/titleagreement.png)
+ ![Authentication Agreement](/docs/images/titleagreement.png)
4. Select _Launch Northstar_\
- ![](https://raw.githubusercontent.com/R2Northstar/NorthstarWiki/main/docs/images/titlelaunchnorthstar.png)
+ ![Launch Northstar](/docs/images/titlelaunchnorthstar.png)
5. From the multiplayer menu, you can use the server browser to select and join any of the public community hosted servers.\
- ![](https://raw.githubusercontent.com/R2Northstar/NorthstarWiki/main/docs/images/lobbyserverbrowser.png)
+ ![Server Browser](/docs/images/lobbyserverbrowser.png)
Should you notice any issues/warnings/errors while running Northstar, check the troubleshooting page.
diff --git a/docs/installing-northstar/using-northstar/commands.md b/docs/installing-northstar/using-northstar/commands.md
index 43e428e..4284e47 100644
--- a/docs/installing-northstar/using-northstar/commands.md
+++ b/docs/installing-northstar/using-northstar/commands.md
@@ -1,6 +1,6 @@
# Commands
-### Opening the Console
+## 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, ...).
@@ -12,13 +12,13 @@ To open your console you'll either have to switch to the English (US) layout **b
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.
-```
+```txt
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
-```
+```txt
bind "F5" "toggleconsole"
```
@@ -43,6 +43,7 @@ In the future this keybind should hopefully be adjustable via `Controls > Settin
| `r_latencyflex` | Enables [LatencyFleX](../../using-northstar/playing-on-linux/#latencyflex) (Linux-only, enabled by default) | `0` / `1` |
### Useful dev commands
+
Requires `sv_cheats 1`
Command|Result
diff --git a/docs/installing-northstar/using-northstar/gamemodes.md b/docs/installing-northstar/using-northstar/gamemodes.md
index 9944e03..17fd52c 100644
--- a/docs/installing-northstar/using-northstar/gamemodes.md
+++ b/docs/installing-northstar/using-northstar/gamemodes.md
@@ -41,5 +41,3 @@ Complex, Forwardbase Kodai, and Colony have had control panels added with [the v
## Competitive CTF
CTF with custom settings for Comp games.
-
-
diff --git a/docs/installing-northstar/using-northstar/mods.md b/docs/installing-northstar/using-northstar/mods.md
index 07728c3..bce2c4e 100644
--- a/docs/installing-northstar/using-northstar/mods.md
+++ b/docs/installing-northstar/using-northstar/mods.md
@@ -2,8 +2,7 @@
![Northstar Mods](https://user-images.githubusercontent.com/7439692/146625579-20586c9e-2e23-4c5d-ba56-27b6eb1ffff4.jpg)
-
-## Pre-installed mods:
+## 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.
@@ -11,8 +10,10 @@ Northstar by default comes with 3 mods installed. They are located in the `Titan
- **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
-## Community created mods:
+## Community created mods
+
Northstar additionally has many mods that are created by members of the community which are avaliable on the [Northstar Discord](https://northstar.tf/discord).
They can be found in the following channels:
+
- `#northstar-client-mods` for client-side only mods like HUD changes, skins, etc.
- `#northstar-server-mods` for mods that primarily target servers, like new gamemodes, moderation tools, etc.
diff --git a/docs/installing-northstar/using-northstar/playing-on-linux.md b/docs/installing-northstar/using-northstar/playing-on-linux.md
index c1c0fc2..ecdf81d 100644
--- a/docs/installing-northstar/using-northstar/playing-on-linux.md
+++ b/docs/installing-northstar/using-northstar/playing-on-linux.md
@@ -17,29 +17,30 @@ Linux is not officially supported currently. However, you can get it working thr
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. Using [Proton GE](https://github.com/GloriousEggroll/proton-ge-custom) has also been reported to resolve the issue.
-
+>
> If you are still suffering from this bug, try running the game through Lutris. The bug doesn't seem to happen there
### Lutris (Wine)
-1. If you don't already have the game downloaded, install the game [from here.](https://lutris.net/games/titanfall-2/)
+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.
+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.
+> **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)
## LatencyFleX
+
LatencyFleX is a Linux-only input latency reduction alternative to Nvidia Reflex that is supported by Northstar. Currently, LatencyFleX requires manual installation. A full install guide and current releases [can be found on their GitHub](https://github.com/ishitatsuyuki/LatencyFleX).
Northstar only requires the [Vulkan layer](https://github.com/ishitatsuyuki/LatencyFleX#latencyflex-vulkan-layer-essential) and [Wine extensions](https://github.com/ishitatsuyuki/LatencyFleX#latencyflex-wine-extensions-required-for-proton-reflex-integration) steps to be completed.
@@ -49,7 +50,7 @@ Once installed, LatencyFleX can be enabled by doing either of the following:
- **Steam:** Add the following to your Titanfall 2 launch options: `"LFX=1 %command%"`
- **Lutris:** Right click on Titanfall 2, click 'Configure', navigate to 'System Preferences' / 'System Options' / 'Environmental Variables', and use the following:
-> Key: LFX
+> Key: LFX
Value: 1
Once in-game, LatencyFleX can be toggled off and on using the `"r_latencyflex"` console variable.
@@ -82,4 +83,4 @@ Some users have reported issues with enabling LatencyFleX. If you see `"Unable t
### Game crashes on launch with Cause: Access Violation Data Execution Prevention (DEP) at: 0x00000000
-try running with ProtonGE https://github.com/GloriousEggroll/proton-ge-custom/.
+try running with [ProtonGE](https://github.com/GloriousEggroll/proton-ge-custom/).