aboutsummaryrefslogtreecommitdiff
path: root/docs/using-northstar/launch-arguments.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/using-northstar/launch-arguments.md')
-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` |