# Legendary ## A free and open-source Epic Games Launcher alternative ![Logo](https://repository-images.githubusercontent.com/249938026/80b18f80-96c7-11ea-9183-0a8c96e7cada) [![Discord](https://discordapp.com/api/guilds/695233346627698689/widget.png?style=shield)](https://legendary.gl/discord) [![Twitter Follow](https://img.shields.io/twitter/follow/legendary_gl?label=Follow%20us%20for%20updates%21&style=social)](https://twitter.com/legendary_gl) Legendary is an open-source game launcher that can download and install games from the Epic Games platform on Linux and Windows. Its name as a tongue-in-cheek play on tiers of [item rarity in many MMORPGs](https://wow.gamepedia.com/Quality). Right now Legendary is in beta and not feature-complete. You might run into some bugs or issues. If you do please [tell us on our Discord](https://legendary.gl/discord) or [create an issue on GitHub](https://github.com/derrod/legendary/issues/new/choose) so we can fix it! Please read the the [config file](#config-file) and [cli usage](#usage) sections before creating an issue to avoid invalid reports. **Note:** Legendary is currently a CLI (command-line interface) application without a graphical user interface, it has to be run from a terminal (e.g. PowerShell) **What works:** - Authenticating with Epic's service - Downloading and installing your games and their DLC - Delta patching/updating of installed games - Launching games with online authentication (for multiplayer/DRM) - Syncing cloud saves (compatible with EGL) - Running games with WINE on Linux - Importing/Exporting installed games from/to the Epic Games Launcher **Planned:** - Simple GUI for managing/launching games - Better interfaces for other developers to use Legendary in their projects - Lots and lots of bug fixes, optimizations, and refactoring... ## Requirements - Linux, Windows, or macOS (64-bit) + macOS support is in an early stage, and only tested on 12.0+ - python 3.8+ (64-bit) - PyPI packages: `requests`, optionally `setuptools` and `wheel` for setup/building ## How to run/install ### Package Manager Several distros already have packages available, check out the [Available Linux Packages](https://github.com/derrod/legendary/wiki/Available-Linux-Packages) wiki page for details. Currently this includes [Arch](https://github.com/derrod/legendary/wiki/Available-Linux-Packages#arch-aur), [Fedora](https://github.com/derrod/legendary/wiki/Available-Linux-Packages#fedora), [openSUSE](https://github.com/derrod/legendary/wiki/Available-Linux-Packages#opensuse), and [Gentoo](https://github.com/derrod/legendary/wiki/Available-Linux-Packages#gentoo) but more will be available in the future. Note that since packages are maintained by third parties it may take a bit for them to be updated to the latest version. If you always want to have the latest features and fixes available then using the PyPI distribution is recommended. ### Standalone Download the `legendary` or `legendary.exe` binary from [the latest release](https://github.com/derrod/legendary/releases/latest) and move it to somewhere in your `$PATH`/`%PATH%`. Don't forget to `chmod +x` it on Linux. The Windows .exe and Linux executable were created with PyInstaller and will run standalone even without python being installed. Note that on Linux glibc >= 2.25 is required, so older distributions such as Ubuntu 16.04 or Debian stretch will not work. ### Python package #### Prerequisites To prevent problems with permissions during installation, please upgrade your `pip` by running `python -m pip install -U pip --user`. > **Tip:** You may need to replace `python` in the above command with `python3.8` on Linux, or `py -3.8` on Windows. #### Installation from PyPI (recommended) Legendary is available on [PyPI](https://pypi.org/project/legendary-gl/), to install simply run: ```bash pip install legendary-gl ``` Optionally if logging in via an embedded web view is desired also run ```bash pip install legendary-gl[webview] ``` On Linux this may also require installing a supported web engine and its python bindings. Ubunutu example: ```bash sudo apt install python3-gi-cairo pip install legendary-gl[webview] ``` Alternatively `pip install legendary-gl[webview_gtk]` or `pip install pywebview[gtk]` will work but may require manually installing dependencies needed to build `PyGObject`. **Note:** Using pywebview's Qt engine may not work correctly. #### Manually from the repo - Install python3.8, setuptools, wheel, and requests - Clone the git repository and cd into it - Run `pip install .` #### Ubuntu 20.04 example Ubuntu 20.04's standard repositories include everything needed to install legendary: ````bash sudo apt install python3 python3-requests python3-setuptools-git git clone https://github.com/derrod/legendary.git cd legendary pip install . ```` If the `legendary` executable is not available after installation, you may need to configure your `PATH` correctly. You can do this by running the command: ```bash echo 'export PATH=$PATH:~/.local/bin' >> ~/.profile && source ~/.profile ``` ### Directly from the repo (for dev/testing) - Install python3.8 and requests (optionally in a venv) - cd into the repository - Run `pip install -e .` This installs `legendary` in "editable" mode - any changes to the source code will take effect next time the `legendary` executable runs. ## Quickstart **Tip:** When using PowerShell with the standalone executable, you may need to replace `legendary` with `.\legendary` in the commands below. To log in: ```` legendary auth ```` When using the prebuilt Windows executables of version 0.20.14 or higher this should open a new window with the Epic Login. Otherwise, authentication is a little finicky since we have to go through the Epic website and manually copy a code. The login page should open in your browser and after logging in you should be presented with a JSON response that contains a code ("sid"), just copy the code into the terminal and hit enter. Alternatively you can use the `--import` flag to import the authentication from the Epic Games Launcher (manually specifying the used WINE prefix may be required on Linux). Note that this will log you out of the Epic Launcher. 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 ```` **Note:** the name used here is generally the game's "app name" as seen in the games list rather than its title, but as of 0.20.12 legendary will try to match game names or abbreviations thereof as well. In this case `legendary install world of goo` or `legendary install wog` would also work! List installed games and check for updates ```` legendary list-installed --check-updates ```` Launch (run) a game with online authentication ```` legendary launch Anemone ```` **Tip:** most games will run fine offline (`--offline`), and thus won't require launching through legendary for online authentication. You can run `legendary launch --offline --dry-run` to get a command line that will launch the game with all parameters that would be used by the Epic Launcher. These can then be entered into any other game launcher (e.g. Lutris/Steam) if the game requires them. Importing a previously installed game ```` legendary import-game Anemone /mnt/games/Epic/WorldOfGoo ```` **Note:** Importing will require a full verification so Legendary can correctly update the game later. **Note 2:** In order to use an alias here you may have to put it into quotes if if contains more than one word, e.g. `legendary import-game "world of goo" /mnt/games/Epic/WorldOfGoo`. Sync savegames with the Epic Cloud ```` legendary sync-saves ```` **Note:** When this command is run the first time after a supported game has been installed it will ask you to confirm or provide the path to where the savegame is located. Automatically sync all games with the Epic Games Launcher ```` legendary -y egl-sync ```` ## Usage ```` usage: legendary [-h] [-v] [-y] [-V] [-c ] [-J] {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} ... Legendary v0.X.X - "Codename" optional arguments: -h, --help show this help message and exit -v, --debug Set loglevel to debug -y, --yes Default to yes for all prompts -V, --version Print version and exit -c , --config-file Specify custom config file or name for the config file in the default directory. -J, --pretty-json Pretty-print JSON Commands: {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} auth Authenticate with EPIC install (download,update,repair) Download a game uninstall Uninstall (delete) a game launch Launch a game list-games List available (installable) games list-installed List installed games list-files List files in manifest list-saves List available cloud saves download-saves Download all cloud saves clean-saves Clean cloud saves sync-saves Sync cloud saves verify-game Verify a game's local files import-game Import an already installed game egl-sync Setup or run Epic Games Launcher sync status Show legendary status information info Prints info about specified app name or manifest alias Manage aliases cleanup Remove old temporary, metadata, and manifest files Individual command help: Command: auth usage: legendary auth [-h] [--import] [--code ] [--sid ] [--delete] [--disable-webview] optional arguments: -h, --help show this help message and exit --import Import Epic Games Launcher authentication data (logs out of EGL) --code Use specified exchange code instead of interactive authentication --sid Use specified session id instead of interactive authentication --delete Remove existing authentication (log out) --disable-webview Do not use embedded browser for login Command: install usage: legendary install [options] Aliases: download, update positional arguments: Name of the app optional arguments: -h, --help show this help message and exit --base-path Path for game installations (defaults to ~/legendary) --game-folder Folder for game installation (defaults to folder specified in metadata) --max-shared-memory Maximum amount of shared memory to use (in MiB), default: 1 GiB --max-workers Maximum amount of download workers, default: min(2 * CPUs, 16) --manifest Manifest URL or path to use instead of the CDN one (e.g. for downgrading) --old-manifest Manifest URL or path to use as the old one (e.g. for testing patching) --delta-manifest Manifest URL or path to use as the delta one (e.g. for testing) --base-url Base URL to download from (e.g. to test or switch to a different CDNs) --force Download all files / ignore existing (overwrite) --disable-patching Do not attempt to patch existing installation (download entire changed files) --download-only, --no-install Do not install app and do not run prerequisite installers after download --update-only Only update, do not do anything if specified app is not installed --dlm-debug Set download manager and worker processes' loglevel to debug --platform Platform for install (default: installed or Windows) --prefix Only fetch files whose path starts with (case insensitive) --exclude Exclude files starting with (case insensitive) --install-tag Only download files with the specified install tag --enable-reordering Enable reordering optimization to reduce RAM requirements during download (may have adverse results for some titles) --dl-timeout Connection timeout for downloader (default: 10 seconds) --save-path Set save game path to be used for sync-saves --repair Repair installed game by checking and redownloading corrupted/missing files --repair-and-update Update game to the latest version when repairing --ignore-free-space Do not abort if not enough free space is available --disable-delta-manifests Do not use delta manifests when updating (may increase download size) --reset-sdl Reset selective downloading choices (requires repair to download new components) --skip-sdl Skip SDL prompt and continue with defaults (only required game data) --disable-sdl Disable selective downloading for title, reset existing configuration (if any) --preferred-cdn Set the hostname of the preferred CDN to use when available --no-https Download games via plaintext HTTP (like EGS), e.g. for use with a lan cache --with-dlcs Automatically install all DLCs with the base game --skip-dlcs Do not ask about installing DLCs. Command: uninstall usage: legendary uninstall [-h] [--keep-files] positional arguments: Name of the app optional arguments: -h, --help show this help message and exit --keep-files Keep files but remove game from Legendary database Command: launch usage: legendary launch [options] Note: additional arguments are passed to the game positional arguments: Name of the app optional arguments: -h, --help show this help message and exit --offline Skip login and launch game without online authentication --skip-version-check Skip version check when launching game in online mode --override-username Override username used when launching the game (only works with some titles) --dry-run Print the command line that would have been used to launch the game and exit --language Override language for game launch (defaults to system locale) --wrapper Wrapper command to launch game with --set-defaults Save parameters used to launch to config (does not include env vars) --reset-defaults Reset config settings for app and exit --override-exe Override executable to launch (relative path) --origin Launch Origin to activate or run the game. --json Print launch information as JSON and exit --wine Set WINE binary to use to launch the app --wine-prefix Set WINE prefix to use --no-wine Do not run game with WINE (e.g. if a wrapper is used) Command: list-games usage: legendary list-games [-h] [--platform ] [--include-ue] [--include-non-installable] [--csv] [--tsv] [--json] [--force-refresh] optional arguments: -h, --help show this help message and exit --platform Override platform that games are shown for (e.g. Win32/Mac) --include-ue Also include Unreal Engine content (Engine/Marketplace) in list --include-non-installable Include apps that are not installable (e.g. that have to be activated on Origin) --csv List games in CSV format --tsv List games in TSV format --json List games in JSON format --force-refresh Force a refresh of all game metadata Command: list-installed usage: legendary list-installed [-h] [--check-updates] [--csv] [--tsv] [--json] [--show-dirs] optional arguments: -h, --help show this help message and exit --check-updates Check for updates for installed games --csv List games in CSV format --tsv List games in TSV format --json List games in JSON format --show-dirs Print installation directory in output Command: list-files usage: legendary list-files [-h] [--force-download] [--platform ] [--manifest ] [--csv] [--tsv] [--json] [--hashlist] [--install-tag ] [] positional arguments: Name of the app (optional) optional arguments: -h, --help show this help message and exit --force-download Always download instead of using on-disk manifest --platform Platform (default: Windows) --manifest Manifest URL or path to use instead of the CDN one --csv Output in CSV format --tsv Output in TSV format --json Output in JSON format --hashlist Output file hash list in hashcheck/sha1sum -c compatible format --install-tag Show only files with specified install tag Command: list-saves usage: legendary list-saves [-h] [] positional arguments: Name of the app (optional) optional arguments: -h, --help show this help message and exit Command: download-saves usage: legendary download-saves [-h] [] positional arguments: Name of the app (optional) optional arguments: -h, --help show this help message and exit Command: clean-saves usage: legendary clean-saves [-h] [--delete-incomplete] [] positional arguments: Name of the app (optional) optional arguments: -h, --help show this help message and exit --delete-incomplete Delete incomplete save files Command: sync-saves usage: legendary sync-saves [-h] [--skip-upload] [--skip-download] [--force-upload] [--force-download] [--save-path ] [--disable-filters] [] positional arguments: Name of the app (optional) optional arguments: -h, --help show this help message and exit --skip-upload Only download new saves from cloud, don't upload --skip-download Only upload new saves from cloud, don't download --force-upload Force upload even if local saves are older --force-download Force download even if local saves are newer --save-path Override savegame path (requires single app name to be specified) --disable-filters Disable save game file filtering Command: verify-game usage: legendary verify-game [-h] positional arguments: Name of the app optional arguments: -h, --help show this help message and exit Command: import-game usage: legendary import-game [-h] [--disable-check] [--with-dlcs] [--skip-dlcs] [--platform ] positional arguments: Name of the app Path where the game is installed optional arguments: -h, --help show this help message and exit --disable-check Disables completeness check of the to-be-imported game installation (useful if the imported game is a much older version or missing files) --with-dlcs Automatically attempt to import all DLCs with the base game --skip-dlcs Do not ask about importing DLCs. --platform Platform override for import Command: egl-sync usage: legendary egl-sync [-h] [--egl-manifest-path EGL_MANIFEST_PATH] [--egl-wine-prefix EGL_WINE_PREFIX] [--enable-sync] [--disable-sync] [--one-shot] [--import-only] [--export-only] [--unlink] optional arguments: -h, --help show this help message and exit --egl-manifest-path EGL_MANIFEST_PATH Path to the Epic Games Launcher's Manifests folder, should point to /ProgramData/Epic/EpicGamesLauncher/Data/Manifests --egl-wine-prefix EGL_WINE_PREFIX Path to the WINE prefix the Epic Games Launcher is installed in --enable-sync Enable automatic EGL <-> Legendary sync --disable-sync Disable automatic sync and exit --one-shot Sync once, do not ask to setup automatic sync --import-only Only import games from EGL (no export) --export-only Only export games to EGL (no import) --unlink Disable sync and remove EGL metadata from installed games Command: status usage: legendary status [-h] [--offline] [--json] optional arguments: -h, --help show this help message and exit --offline Only print offline status information, do not login --json Show status in JSON format Command: info usage: legendary info [-h] [--offline] [--json] [--platform ] positional arguments: App name or manifest path/URI optional arguments: -h, --help show this help message and exit --offline Only print info available offline --json Output information in JSON format --platform Platform to fetch info for (default: installed or Windows) Command: alias usage: legendary alias [-h] [App name/Old alias] [New alias] positional arguments: Action: Add, rename, remove, or list alias(es) App name/Old alias App name when using "add" or "list" action, existing alias when using "rename" or "remove" action New alias New alias when using "add" action optional arguments: -h, --help show this help message and exit Command: cleanup usage: legendary cleanup [-h] [--keep-manifests] optional arguments: -h, --help show this help message and exit --keep-manifests Do not delete old manifests ```` ## Environment variables Legendary supports overriding certain things via environment variables, it also passes through any environment variables set before it is called. Legendary specific environment variables: + `LGDRY_WINE_BINARY` - specifies wine binary + `LGDRY_WINE_PREFIX` - specified wine prefix + `LGDRY_NO_WINE` - disables wine + `LGDRY_WRAPPER` - specifies wrapper binary/command line Note that the priority for settings that occur multiple times is: command line > environment variables > config variables. ## Config file Legendary supports some options as well as game specific configuration in `~/.config/legendary/config.ini`: ````ini [Legendary] log_level = debug ; maximum shared memory (in MiB) to use for installation max_memory = 1024 ; maximum number of worker processes when downloading (fewer workers will be slower, but also use fewer system resources) max_workers = 8 ; default install directory install_dir = /mnt/tank/games ; locale override, must be in RFC 1766 format (e.g. "en-US") locale = en-US ; whether or not syncing with egl is enabled egl_sync = false ; path to the "Manifests" folder in the EGL ProgramData directory egl_programdata = /home/user/Games/epic-games-store/drive_c/... ; Set preferred CDN host (e.g. to improve download speed) preferred_cdn = epicgames-download1.akamaized.net ; disable HTTPS for downloads (e.g. to use a LanCache) disable_https = false ; Disables the automatic update check disable_update_check = false ; Disables the notice about an available update on exit disable_update_notice = false ; Disable automatically-generated aliases disable_auto_aliasing = false [Legendary.aliases] ; List of aliases for simpler CLI use HITMAN 3 = Eider gtav = 9d2d0eb64d5c44529cece33fe2a46482 ; default settings to use (currently limited to WINE executable) [default] ; (linux) specify wine executable to use wine_executable = wine ; wine prefix (alternative to using environment variable) wine_prefix = /home/user/.wine ; default environment variables to set (overridden by game specific ones) [default.env] WINEPREFIX = /home/user/legendary/.wine ; Settings to only use for "AppName" [AppName] ; launch game without online authentication by default offline = true ; Skip checking for updates when launching this game skip_update_check = true ; start parameters to use (in addition to the required ones) start_params = -windowed wine_executable = /path/to/wine64 ; override language with two-letter language code language = fr [AppName.env] ; environment variables to set for this game (mostly useful on linux) WINEPREFIX = /mnt/tank/games/Game/.wine DXVK_CONFIG_FILE = /mnt/tank/games/Game/dxvk.conf [AppName2] ; Use a wrapper to run this script ; Note that the path might have to be quoted if it contains spaces wrapper = "/path/with spaces/gamemoderun" ; Do not run this executable with WINE (e.g. when the wrapper handles that) no_wine = true ; Override the executable launched for this game, for example to bypass a launcher (e.g. Borderlands) override_exe = relative/path/to/file.exe ; Disable selective downloading for this title disable_sdl = true ````