add new options to readme

This commit is contained in:
Chris
2021-04-24 19:21:29 -06:00
parent 9538e3fac0
commit 11a6706c75

View File

@ -112,15 +112,17 @@ Windows: `%LOCALAPPDATA%\min-ed-launcher\settings.json`
Linux: `$XDG_CONFIG_DIR/min-ed-launcher/settings.json` (`~/.config` if `$XDG_CONFIG_DIR` isn't set) Linux: `$XDG_CONFIG_DIR/min-ed-launcher/settings.json` (`~/.config` if `$XDG_CONFIG_DIR` isn't set)
| Settings | Effect | | Settings | Effect |
|-----------------|------------------------------------------------------------------------------------------------------------------------| |------------------------|------------------------------------------------------------------------------------------------------------------------|
| apiUri | FDev API base URI. Should only be changed if you are doing local development | | apiUri | FDev API base URI. Should only be changed if you are doing local development |
| watchForCrashes | Determines if the game should be launched by `WatchDog64.exe` or not | | watchForCrashes | Determines if the game should be launched by `WatchDog64.exe` or not |
| gameLocation | Path to game's install folder. Specify this if the launcher can't figure it out by itself | | gameLocation | Path to game's install folder. Specify this if the launcher can't figure it out by itself |
| language | Sets the game's language. Supported values are _en_ and the names of the language folders in Elite's install directory | | language | Sets the game's language. Supported values are _en_ and the names of the language folders in Elite's install directory |
| restart | Restart the game after it has closed | | restart | Restart the game after it has closed |
| forceUpdate | Be default, Steam and Epic updates are handled by their respective platform. In cases like the Odyssey alpha, FDev doesn't provide updates through Steam or Epic. This allows the launcher to force updates to be done via FDev servers by providing a comma delimited list of SKUs | | autoUpdate | Automatically update games that are out of date |
| processes | Additional applications to launch before launching the game | | maxConcurrentDownloads | Maximum number of simultaneous downloads when downloading updates |
| forceUpdate | Be default, Steam and Epic updates are handled by their respective platform. In cases like the Odyssey alpha, FDev doesn't provide updates through Steam or Epic. This allows the launcher to force updates to be done via FDev servers by providing a comma delimited list of SKUs |
| processes | Additional applications to launch before launching the game |
When specifying a path for either `gameLocation` or `processes.fileName` on Windows, it's required to escape backslashes. Make sure to use a When specifying a path for either `gameLocation` or `processes.fileName` on Windows, it's required to escape backslashes. Make sure to use a
double backslash (`\\`) instead of a single backslash (`\`). double backslash (`\\`) instead of a single backslash (`\`).
@ -135,6 +137,8 @@ double backslash (`\\`) instead of a single backslash (`\`).
"enabled": false, "enabled": false,
"shutdownTimeout": 3 "shutdownTimeout": 3
}, },
"autoUpdate": true,
"maxConcurrentDownloads": 4,
"forceUpdate": "PUBLIC_TEST_SERVER_OD", "forceUpdate": "PUBLIC_TEST_SERVER_OD",
"processes": [ "processes": [
{ {