Skip to content

Commit 6fb6bb1

Browse files
committed
Update README
1 parent 0d491ae commit 6fb6bb1

File tree

1 file changed

+36
-8
lines changed

1 file changed

+36
-8
lines changed

README.md

Lines changed: 36 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -180,9 +180,7 @@ legendary -y egl-sync
180180
## Usage
181181

182182
````
183-
usage: legendary [-h] [-v] [-y] [-V] [-c <path/name>] [-J]
184-
{auth,install,download,update,repair,uninstall,launch,list-games,list-installed,list-files,list-saves,download-saves,clean-saves,sync-saves,verify-game,import-game,egl-sync,status,info,alias,cleanup,activate}
185-
...
183+
usage: legendary [-h] [-v] [-y] [-V] [-J] [-H] <command> ...
186184
187185
Legendary v0.X.X - "Codename"
188186
@@ -191,14 +189,12 @@ optional arguments:
191189
-v, --debug Set loglevel to debug
192190
-y, --yes Default to yes for all prompts
193191
-V, --version Print version and exit
194-
-c <path/name>, --config-file <path/name>
195-
Specify custom config file or name for the config file
196-
in the default directory.
197192
-J, --pretty-json Pretty-print JSON
193+
-H, --full-help Show full help (including individual command help)
198194
199195
Commands:
200-
{auth,install,download,update,repair,uninstall,launch,list-games,list-installed,list-files,list-saves,download-saves,clean-saves,sync-saves,verify-game,import-game,egl-sync,status,info,alias,cleanup,activate}
201-
auth Authenticate with EPIC
196+
<command>
197+
auth Authenticate with the Epic Games Store
202198
install (download,update,repair)
203199
Download a game
204200
uninstall Uninstall (delete) a game
@@ -218,6 +214,7 @@ Commands:
218214
alias Manage aliases
219215
cleanup Remove old temporary, metadata, and manifest files
220216
activate Activate games on third party launchers
217+
eos-overlay Manage EOS Overlay install
221218
222219
Individual command help:
223220
@@ -355,6 +352,13 @@ optional arguments:
355352
--wine-prefix <wine pfx path>
356353
Set WINE prefix to use
357354
--no-wine Do not run game with WINE (e.g. if a wrapper is used)
355+
--crossover Interactively configure CrossOver for this
356+
application.
357+
--crossover-app <path to .app>
358+
Specify which App to use for CrossOver (e.g.
359+
"/Applications/CrossOver.app")
360+
--crossover-bottle <bottle name>
361+
Specify which bottle to use for CrossOver
358362
359363
360364
Command: list-games
@@ -580,6 +584,21 @@ optional arguments:
580584
(Uplay install not required)
581585
-O, --origin Activate Origin/EA App managed titles on your EA account
582586
(requires Origin to be installed)
587+
588+
589+
Command: eos-overlay
590+
usage: legendary eos-overlay [-h] [--path PATH]
591+
<install|update|remove|enable|disable|info>
592+
593+
positional arguments:
594+
<install|update|remove|enable|disable|info>
595+
Action: install, remove, enable, disable, or print
596+
info about the overlay
597+
598+
optional arguments:
599+
-h, --help show this help message and exit
600+
--path PATH Path to the EOS overlay folder to be enabled/installed
601+
to.
583602
````
584603

585604

@@ -627,6 +646,8 @@ disable_update_notice = false
627646
disable_auto_aliasing = false
628647
; Default application platform to use
629648
default_platform = Windows
649+
; (macOS) Disable automatic CrossOver use
650+
disable_auto_crossover = false
630651

631652
[Legendary.aliases]
632653
; List of aliases for simpler CLI use
@@ -639,6 +660,9 @@ gtav = 9d2d0eb64d5c44529cece33fe2a46482
639660
wine_executable = wine
640661
; wine prefix (alternative to using environment variable)
641662
wine_prefix = /home/user/.wine
663+
; (macOS) CrossOver options
664+
crossover_app = /Applications/CrossOver.app
665+
crossover_bottle = Legendary
642666

643667
; default environment variables to set (overridden by game specific ones)
644668
[default.env]
@@ -671,4 +695,8 @@ no_wine = true
671695
override_exe = relative/path/to/file.exe
672696
; Disable selective downloading for this title
673697
disable_sdl = true
698+
699+
[AppName3]
700+
; (macOS) override crossover bottle
701+
crossover_bottle = SomethingElse
674702
````

0 commit comments

Comments
 (0)