diff options
| author | Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com> | 2022-08-16 22:03:22 -0400 |
|---|---|---|
| committer | Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com> | 2022-08-16 22:03:22 -0400 |
| commit | f23cd450a0cca3ede1dacb198b4dd6432a44bf16 (patch) | |
| tree | 21ed8c22b382573762f0f3f5a3545bbb4b168303 | |
| parent | 5ab87efaa07a0972fd59c88c8aab456a6133329d (diff) | |
| download | SMAPI-f23cd450a0cca3ede1dacb198b4dd6432a44bf16.tar.gz SMAPI-f23cd450a0cca3ede1dacb198b4dd6432a44bf16.tar.bz2 SMAPI-f23cd450a0cca3ede1dacb198b4dd6432a44bf16.zip | |
clarify docs
| -rw-r--r-- | docs/technical/smapi.md | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/technical/smapi.md b/docs/technical/smapi.md index 90990ee4..b8a1683b 100644 --- a/docs/technical/smapi.md +++ b/docs/technical/smapi.md @@ -33,14 +33,15 @@ argument | purpose `--uninstall` | Preselects the uninstall action, skipping the prompt asking what the user wants to do. `--game-path "path"` | Specifies the full path to the folder containing the Stardew Valley executable, skipping automatic detection and any prompt to choose a path. If the path is not valid, the installer displays an error. -SMAPI itself recognises five arguments **on Windows only**, but these are intended for internal use -or testing and may change without warning. On Linux/macOS, see _environment variables_ below. +SMAPI itself recognises five arguments, but these are meant for internal use or testing, and might +change without warning. **On Linux/macOS**, command-line arguments won't work; see _environment +variables_ below instead. argument | purpose -------- | ------- `--developer-mode`<br />`--developer-mode-off` | Enable or disable features intended for mod developers. Currently this only makes `TRACE`-level messages appear in the console. -`--no-terminal` | The SMAPI launcher won't try to open a terminal window, and SMAPI won't log anything to the console. (Messages will still be written to the log file.) -`--use-current-shell` | The SMAPI launcher won't try to open a terminal window, but SMAPI will still log to the console. (Messages will still be written to the log file.) +`--no-terminal` | SMAPI won't log anything to the console. On Linux/macOS only, this will also prevent the launch script from trying to open a terminal window. (Messages will still be written to the log file.) +`--use-current-shell` | On Linux/macOS only, the launch script won't try to open a terminal window. All console output will be sent to the shell running the launch script. `--mods-path` | The path to search for mods, if not the standard `Mods` folder. This can be a path relative to the game folder (like `--mods-path "Mods (test)"`) or an absolute path. ### Environment variables |