-
-
Notifications
You must be signed in to change notification settings - Fork 166
Setup Instructions
I've seen a lot of people being confused about how to setup Legendary, how it's meant to be ran and where to put the .EXE file. This page aims at helping those people.
Legendary is a "CLI" program. To interact with it, you open up a Command Prompt (CMD.EXE
) and type in legendary
followed by the action you want it to do. More on that in a bit.
There are two ways to install legendary: Using the .exe version or installing using pip
. I'll cover both here
PIP (pip installs packages/python) is, as the name suggests, a package manager for python. To use it, you'll have to install Python from https://www.python.org/downloads/. It's used similar to legendary, by opening up a Command Prompt and typing in pip
followed by tasks. To install legendary with it, type in pip install legendary-gl
.
I'd recommend PIP over the .EXE method, as legendary will automatically get added to your %PATH%
(meaning you can use it everywhere) and updates are easy (pip install legendary-gl -U
to download and install updates)
For the EXE, technically all you have to do is download it. However, it will not automatically get added to your %PATH%
, so to use it you'll have to be in the folder it's in. For example, if you placed the EXE inside C:/Users/Username/Downloads/
, your Command Prompt also has to be in that specific folder for legendary
to be a recognized command.
To add legendary to your %PATH%
, open up a Command Prompt and type in echo %PATH%
. That will print a list of directories, separated by semicolons (;
). Pick one of the directories and copy it (right-clicking inside a Command Prompt copies selected text). Then, open up an Explorer window and click inside the "Current working directory" field (marked here in red)
and paste in the copied text, followed by pressing Enter/Return. Now, copy the .exe file into that folder.
After doing so, running legendary
should now work everywhere.
After installing legendary using one of the methods described above, these are some basic commands to get you going:
legendary auth
is the first command you should run. It is used to log into your Epic account (needed to get your game list, launch games, etc)
legendary list
lists all the games in your account (as to why Battlefront 2 is not showing up, see Issue #202)
legendary egl-sync
enables syncing games from the Epic Games Store.
legendary launch
launches games (using the App Names you get from list-games
and list-installed
)
Lastly, all of those commands have plenty of switches and options, which can be listed by adding a -h
to any command (e. g. legendary launch -h
)