aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorlizzie <lizzie@eden-emu.dev>2026-09-23 14:51:51 +0200
committercrueter <crueter@eden-emu.dev>2026-09-23 14:51:51 +0200
commit278f411dad6e8a52747994888f8778b277f6d953 (patch)
treee84710ade94d0f4d6ed72d48c87c3b54328d8e5a /docs
parent3d37a816c6adc2708a7be70f5a7fbe0af36b8227 (diff)
[frontend] Unify cmdline parsing (#4424)
Addresses #4383. Makes it so both the Qt and SDL frontends now share the same options (bar `-hlaunch` and `-qlaunch`). Signed-off-by: lizzie <lizzie@eden-emu.dev> - [x] I have read and followed the [Contribution Guidelines](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/CONTRIBUTING.md#code-contributions). - [x] I have read and followed the [AI Policy](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/docs/policies/AI.md) - [x] I have read and followed the [Coding Guidelines](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/docs/policies/Coding.md) to the best of my ability. ------------------- Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/4424 Reviewed-by: MaranBr <maranbr@eden-emu.dev> Reviewed-by: Maufeat <sahyno1996@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/user/CommandLine.md50
1 files changed, 31 insertions, 19 deletions
diff --git a/docs/user/CommandLine.md b/docs/user/CommandLine.md
index b8d71ac61f..a63a41a27c 100644
--- a/docs/user/CommandLine.md
+++ b/docs/user/CommandLine.md
@@ -1,32 +1,44 @@
# User Handbook - Command Line
-There are two main applications, an SDL-based app (`eden-cli`) and a Qt based app (`eden`); both accept command line arguments.
-
-## eden
+There are two main applications, an SDL-based app (`eden-cli`) and a Qt based app (`eden`); both accept the same command line arguments.
- `./eden <path>`: Running with a single argument and nothing else, will make the emulator look for the given file and load it, this behavior is similar to `eden-cli`; allows dragging and dropping games into the application.
-- `-g <path>`: Alternate way to specify what to load, overrides. However let it be noted that arguments that use `-` will be treated as options/ignored, if your game, for some reason, starts with `-`, in order to safely handle it you may need to specify it as an argument.
-- `-f`: Use fullscreen.
-- `-u <number>`: Select the index of the user to load as.
-- `-input-profile <name>`: Specifies input profile name to use (for player #0 only).
-- `-qlaunch`: Launch QLaunch.
-- `-hlaunch`: Launch homebrew launcher `nx-hbloader`.
- - Requires a copy of Atmosphere to be extracted onto `sdmc`.
- - This is a shorthand for `<eden folder>/sdmc/atmosphere/hbl.nsp`.
-- `-setup`: Launch setup applet.
-
-## eden-cli
-
- `--debug/-d`: Enter debug mode, allow gdb stub at port `1234`
- `--config/-c`: Specify alternate configuration file.
-- `--fullscreen/-f`: Set fullscreen.
+- `--fullscreen/-f`: Use fullscreen.
- `--help/-h`: Display help.
-- `--game/-g`: Specify the game to run.
+- `--game/-g <path>`: Alternate way to specify what to load, overrides. However let it be noted that arguments that use `-` will be treated as options/ignored, if your game, for some reason, starts with `-`, in order to safely handle it you may need to specify it as an argument.
- `--multiplayer/-m`: Specify multiplayer options.
- `--program/-p`: Specify the program arguments to pass (optional).
-- `--user/-u`: Specify the user index.
+- `--user/-u <number>`: Specify the user index.
- `--version/-v`: Display version and quit.
-- `--input-profile/-i`: Specifies input profile name to use (for player #0 only).
+- `--input-profile/-i <name>`: Specifies input profile name to use (for player #0 only).
- `--null-render/-n`: Forces the usage of the "Null" render backend irrespective of settings.
- `--filter/-x`: Sets the debug log filter irrespective of settings.
- `--singlecore/-s`: Forces single-core regardless of settings.
+
+Only the Qt frontend supports the following arguments:
+
+- `-qlaunch`: Launch QLaunch.
+- `-hlaunch`: Launch homebrew launcher `nx-hbloader`.
+ - Requires a copy of Atmosphere to be extracted onto `sdmc`.
+ - This is a shorthand for `<eden folder>/sdmc/atmosphere/hbl.nsp`.
+- `-setup`: Launch setup applet.
+
+`eden` (provided with `--room`), and `eden-room` supports the following options as well:
+
+- `-n/--room-name`: The name of the room.
+- `-d/--room-description`: The room description.
+- `-s/--bind-address`: The bind address for the room.
+- `-p/--port`: The port used for the room.
+- `-m/--max-members`: The maximum number of players for this room.
+- `-w/--password`: The password for the room.
+- `-g/--preferred-game`: The preferred game for this room.
+- `-i/--preferred-game-id`: The preferred game-id for this room.
+- `-u/--username`: The username used for announce.
+- `-t/--token`: The token used for announce.
+- `-a/--web-api-url`: yuzu Web API url.
+- `-b/--ban-list-file`: The file for storing the room ban list.
+- `-l/--log-file`: The file for storing the room log.
+- `-h/--help`: Display this help and exit.
+- `-v/--version`: Output version information and exit.