Skip to content

Commit dc24718

Browse files
committed
Update README
1 parent f78674b commit dc24718

1 file changed

Lines changed: 20 additions & 2 deletions

File tree

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ Legendary is an open-source game launcher that can download and install games fr
88
Its name as a tongue-in-cheek play on tiers of [item rarity in many MMORPGs](https://wow.gamepedia.com/Quality).
99

1010
Right now Legendary is in beta and not feature-complete. You might run into some bugs or issues.
11-
If you do please [create an issue on GitHub](https://github.com/derrod/legendary/issues/new) so we can fix it.
11+
If you do please [create an issue on GitHub](https://github.com/derrod/legendary/issues/new/choose) so we can fix it.
12+
13+
Please read the the [config file](#config-file) and [cli usage](#usage) sections before creating an issue to avoid invalid reports.
1214

1315
**Note:** Legendary is currently a CLI (command-line interface) application without a graphical user interface,
1416
it has to be run from a terminal (e.g. PowerShell)
@@ -237,7 +239,7 @@ optional arguments:
237239
--disable-patching Do not attempt to patch existing installation
238240
(download entire changed files)
239241
--download-only, --no-install
240-
Do not intall app and do not run prerequisite
242+
Do not install app and do not run prerequisite
241243
installers after download
242244
--update-only Only update, do not do anything if specified app is
243245
not installed
@@ -266,6 +268,11 @@ optional arguments:
266268
download size)
267269
--reset-sdl Reset selective downloading choices (requires repair
268270
to download new components)
271+
--preferred-cdn <hostname>
272+
Set the hostname of the preferred CDN to use when
273+
available
274+
--no-https Download games via plaintext HTTP (like EGS), e.g. for
275+
use with a lan cache
269276
270277
271278
Command: uninstall
@@ -305,6 +312,8 @@ optional arguments:
305312
--set-defaults Save parameters used to launch to config (does not
306313
include env vars)
307314
--reset-defaults Reset config settings for app and exit
315+
--override-exe <exe path>
316+
Override executable to launch (relative path)
308317
--wine <wine binary> Set WINE binary to use to launch the app
309318
--wine-prefix <wine pfx path>
310319
Set WINE prefix to use
@@ -322,6 +331,9 @@ optional arguments:
322331
Win32/Mac)
323332
--include-ue Also include Unreal Engine content
324333
(Engine/Marketplace) in list
334+
--include-non-installable
335+
Include apps that are not installable (e.g. that have
336+
to be activated on Origin)
325337
--csv List games in CSV format
326338
--tsv List games in TSV format
327339
--json List games in JSON format
@@ -503,6 +515,10 @@ locale = en-US
503515
egl_sync = false
504516
; path to the "Manifests" folder in the EGL ProgramData directory
505517
egl_programdata = /home/user/Games/epic-games-store/drive_c/...
518+
; Set preferred CDN host (e.g. to improve download speed)
519+
preferred_cdn = epicgames-download1.akamaized.net
520+
; disable HTTPS for downloads (e.g. to use a LanCache)
521+
disable_https = false
506522

507523
; default settings to use (currently limited to WINE executable)
508524
[default]
@@ -538,4 +554,6 @@ DXVK_CONFIG_FILE = /mnt/tank/games/Game/dxvk.conf
538554
wrapper = "/path/to/Proton 5.0/proton" run
539555
; Do not run this executable with WINE (e.g. when the wrapper handles that)
540556
no_wine = true
557+
; Override the executable launched for this game, for example to bypass a launcher (e.g. Borderlands)
558+
override_exe = relative/path/to/file.exe
541559
````

0 commit comments

Comments
 (0)