Skip to content

Commit

Permalink
Update readme section re: CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
YoshiRulz committed Jul 7, 2024
1 parent 989e012 commit 031596a
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,8 @@ tl;dr:

#### Passing command-line arguments

EmuHawk takes some command-line options which aren't well-documented; you might be able to figure them out from [the source](https://github.com/TASEmulators/BizHawk/blob/78daf4913d4c8e47d24fc14d84ca33ddef913ed4/src/BizHawk.Client.Common/ArgParser.cs).
EmuHawk takes some command-line options which, starting from 2.9.2, can be listed with `--help`.
For everyone not using a dev build, check [the source](https://github.com/TASEmulators/BizHawk/blob/989e012beb8a5a8693bb903b58f95e4655858cde/src/BizHawk.Client.Common/ArgParser.cs) for descriptions of each flag.

On Windows 8.1/10, it's easiest to use PowerShell for this. For example, to pass `--lua=C:\path\to\script.lua` as the first argument and `C:\path\to\rom.n64` as the second, navigate to the BizHawk install folder and run:
```pwsh
Expand All @@ -209,6 +210,7 @@ On Windows 8.1/10, it's easiest to use PowerShell for this. For example, to pass
On Linux, you can pass arguments to `EmuHawkMono.sh` as expected and they will be forwarded to `mono`. (You can also `export` env. vars.) All the arguments work as on Windows, with some caveats:
* file paths must be absolute (or relative to the install dir, `EmuHawkMono.sh` changes the CWD to there);
* `--mono-no-redirect`: if you pass this flag *as the first argument*, it will be eaten by the script itself, and stdout/stderr will *not* be redirected to a file. (It's redirected by default.)
** From 2.9.2, this will no longer be necessary.

The same example as above would be `./EmuHawkMono.sh --lua=/path/to/script.lua /path/to/rom.n64`.

Expand Down

0 comments on commit 031596a

Please sign in to comment.