aboutsummaryrefslogtreecommitdiff
path: root/docs/using-northstar
diff options
context:
space:
mode:
authorCommander Neon <58310402+cmdrneon@users.noreply.github.com>2023-05-08 11:44:19 -0400
committerGitHub <noreply@github.com>2023-05-08 17:44:19 +0200
commit20d7414a6d0663e90705bdc4e3b6171f19d1239a (patch)
treec537f1addd5c05a5571fe2d48a12c245ad28bad5 /docs/using-northstar
parent53aeb9c817a0bb2f99f32c0e810569ac3abbb797 (diff)
downloadNorthstarWiki-20d7414a6d0663e90705bdc4e3b6171f19d1239a.tar.gz
NorthstarWiki-20d7414a6d0663e90705bdc4e3b6171f19d1239a.zip
Move `using-northstar/launch-arguments.md` to the dedicated `using-northstar` directory (#183)
* Move launch-arguments.md to dedicated using-northstar directory and fix link * Update SUMMARY.md
Diffstat (limited to 'docs/using-northstar')
-rw-r--r--docs/using-northstar/launch-arguments.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/using-northstar/launch-arguments.md b/docs/using-northstar/launch-arguments.md
new file mode 100644
index 0000000..9205890
--- /dev/null
+++ b/docs/using-northstar/launch-arguments.md
@@ -0,0 +1,27 @@
+# Launch arguments
+
+Here's a list of new command line arguments that Northstar introduces, they should be included in `ns_startup_args.txt` or `ns_startup_args_dedi.txt`.
+
+| Argument | Description | Value |
+| ------------------ | -------------------------------------------------------------------------------------------------- | -------------------------------- |
+| `-disablelogs` | Disable logging and creation of log files | |
+| `-vanilla` | Disables Northstar loading | |
+| `-northstar` | Enables Northstar loading | |
+| `-dedicated` | Starts a dedicated server without video output | |
+| `-waitfordebugger` | Waits for debugger to connect before launching game | |
+| `-language` | Forces loading of client localisation | language string ex: `portuguese` |
+| `-profile=` | Enabled specifying a different profile directory. Default: R2Northstar | Example: `-profile="dev mods"` |
+| `-enablechathooks` | Enables the use of chathooks for use by mods | |
+| `-noplugins` | Disables the plugin system | |
+
+Here's a list of command line arguments from the base game.
+
+| Argument | Description | Value |
+| ------------------ | -------------------------------------------------------------------------------------------------- | -------------------------------- |
+| `-novid` | Disables startup videos | |
+| `-nosound` | Disables all game sounds | |
+
+# Environment Variables
+| Variable name | Description | Value |
+| ------------------ | -------------------------------------------------------------------------------------------------- | -------------------------------- |
+| `LFX` | Enables the use of [LatencyFleX](../steamdeck-and-linux/installing-on-steamdeck-and-linux.md#latencyflex) (Linux-only) | `0` or `1` |