mirrors/legendary
1
0
Fork 0
mirror of https://github.com/derrod/legendary.git synced 2024-12-22 01:45:28 +00:00
Code Issues Projects Releases Wiki Activity

Add usage examples to README

Browse source
This commit is contained in:
derrod 2020-04-14 15:50:15 +02:00
parent e00e534f2c
commit 82163754ae
1 changed files with 31 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -34,6 +34,37 @@ A PyPI package will follow once it has gotten more testing.
The Windows .exe was created with PyInstaller and will run standalone without python being installed.
## Quickstart
To log in:
````
$ legendary --auth
````
Authentication is a little finicky since we have to go through the Epic website. In the first step you will log in and in the second one you are required to copy an exchange code from a JSON site into the command line.
On Windows you can add `--import` to attempt to import the session from the Epic Games Launcher, if it is installed and you're logged in.
Listing your games
````
$ legendary --list-games
````
This will fetch a list of games available on your account, the first time may take a while depending on how many games you have.
Installing a game
````
$ legendary --install Anemone
````
**Important:** the name used for these commands is the app name, *not* the game's name! The app name is included in the games list after the title.
List installed games and check for updates
````
$ legendary --list-installed --check-updates
````
Launch (run) a game with online authentication
````
$ legendary --launch Anemone
````
## Usage
````