HeroicGamesLauncher README

The project's README from github.com/Heroic-Games-Launcher/HeroicGamesLauncher. As one markdown file: README.md.

Heroic Games Launcher

GitHub release GitHub all releases Flathub GPLv3 license
Discord Patreon PayPal kofi

Heroic is an Open Source Game Launcher for Linux, Windows and macOS.
Right now it supports launching games from the Epic Games Store using Legendary, GOG Games using our custom implementation with gogdl and Amazon Games using Nile.

Heroic is built with Web Technologies:
Typescript React MUI NodeJS Electron electron-builder Jest Vite

Index

Features available right now

Planned features

Supported Operating Systems

Language Support

Expand

Thanks to the community, Heroic was translated to almost 40 different languages so far:

  • English
  • Azerbaijani
  • Basque
  • Belarussian
  • Bosnian
  • Bulgarian
  • Catalan
  • Czech
  • Croatian
  • Simplified Chinese
  • Traditional Chinese
  • Dutch
  • Estonian
  • Finnish
  • French
  • German
  • Greek
  • Hebraic
  • Japanese
  • Korean
  • Hungarian
  • Italian
  • Indonesian
  • Malayalam
  • Norwegian Bokmål
  • Persian
  • Polish
  • Portuguese
  • Portuguese (Brazil)
  • Romanian
  • Russian
  • Serbian
  • Spanish
  • Slovak
  • Swedish
  • Tamil
  • Turkish
  • Ukrainian
  • Vietnamese

Help with Translations Here

Installation

Linux

Flatpak

Flathub Badge

Heroic is available on Flathub, so you should be able to easily install it on most distros with Software Centers (Pop!_Shop, Discover, etc.)

Distribution-specific instructions

If you're not using the Flatpak version, keep GE-Proton as your Wine runner. With umu enabled by default, no additional Wine dependencies are required.

Debian, Ubuntu and Derivatives

Download the file ending in .deb from the latest release.
Double-click it to open it up in your Software Manager, or run sudo dpkg -i Heroic*amd64.deb to install it directly.

Arch (AUR)

We currently only support one AUR package: heroic-games-launcher-bin. Although you might find other packages there, do not ask support for them on this GitHub or on our Discord, ask their maintainers directly.

Please see the Arch Wiki on how to install them

Fedora

You can download the file ending in .rpm from the latest release and install it with sudo dnf install ./heroic-*.x86_64.rpm.

Alternatively, you can use the Flatpak package.

Nix(OS)

Two community-maintained versions are available in nixpkgs, named heroic (with an FHS environment) and heroic-unwrapped (without FHS).

Other Distributions (AppImage and TAR.XZ)

Since these two distribution formats don't have a form of dependency management, make sure the curl command is available. You might run into weird issues if it's not.

AppImage
.tar.xz

Windows

WinGet

If you use WinGet (installed by default on Windows 11 and modern versions of 10), you can run winget install Heroic in a terminal to install Heroic.

Manual installl

Download the Heroic Installer (Heroic-x.x.x-Setup.exe) or the portable version (Heroic-x.x.x-Portable.exe) from the latest release. Run the executable you downloaded to install/run Heroic.
The Setup will create shortcuts to Heroic on your Desktop and in your Start Menu.

macOS

If you use Homebrew, you can run brew install --cask --no-quarantine heroic to install Heroic.
Otherwise, download the file ending in .dmg from the latest release, double-click it to mount it, and drag the "Heroic" application into the "Applications" folder.

Development environment

This part will walk you through setting up a development environment so you can build Heroic binaries yourself or make changes to the code.

  1. Make sure Git, NodeJS, and pnpm 10 are installed
    NOTE: On Windows, due to an issue with electron-builder, you'll need the standalone version of pnpm (@pnpm/exe) to build packages

  2. Clone the repo and enter the cloned folder, for example with these commands:

    git clone https://github.com/Heroic-Games-Launcher/HeroicGamesLauncher.git --recurse-submodules
    cd HeroicGamesLauncher
    
  3. Make sure all dependencies are installed by running pnpm install

  4. Download all helper binaries using pnpm download-helper-binaries

Building Heroic Binaries

Run the appropriate command for your OS:

Building with VS Code

Instead of using the above commands to build Heroic, you can also use the Tasks in VSCode to build. To do that, open up the command palette (Ctrl + P), type in "task" and press Space. You will then see 3 build tasks, "Build for Linux", "Build for Windows", and "Build for MacOS". Click the one you want to run.

Quickly testing/debugging Heroic on your own system

If you want to quickly test a change, or you're implementing features that require a lot of restarts, you can use Vite's development server to speed up the process:
Go to the "Run and Debug" tab of VSCode and start the "Launch Heroic (HMR & HR)" task (alternatively, if you're not using VSCode or just prefer the terminal, run pnpm start). Heroic will start up after a short while, and once you make any change to the code, it'll reload/restart.

Development on Nix

After cloning the repository, Nix users can use nix-shell to make Node.JS/pnpm available and automatically run installation step 3 and 4. See shell.nix for more information.

Sponsors

Thanks Weblate for hosting our translations

weblate

Thanks Signpath for providing free signing of Windows binaries

signpath

Screenshots

Expand

image image image image image image image

Credits

Weblate: Localization platform

Those Awesome Guys: Gamepad prompts images

jump

Tools We Use to Run Games

Heroic would not be possible without the work done in many other projects:

So be sure to follow and support those projects too!

HeroicGamesLauncher (Heroic-Games-Launcher/HeroicGamesLauncher)

wine
Searching Database…

What is this?Heroic Games Launcher is an open-source games launcher that lets you log in to your Epic Games, GOG and Amazon Games accounts and install, update and play your games from one app on Linux, Windows and macOS.
Is this a store itself or just a front-end for other stores?It is a front-end launcher: it does not sell games but connects to your existing Epic, GOG and Amazon accounts and uses backend tools (Legendary, gogdl, Nile) to download and run the games you already own.
Do I need Wine or Proton installed myself to play Windows games?No separate install is required for Flatpak users since GE-Proton/umu is bundled; for other Linux packages you're advised to keep GE-Proton as your Wine runner, and on macOS, games run through Crossover.
Does online anti-cheat work for Epic games?It depends on the specific game: Epic online play with AntiCheat support varies per title on macOS and Linux.
Which OS versions are actually supported?Linux support targets the latest 2 Ubuntu LTS releases, the latest 2 Fedora versions, Arch and derivatives, and SteamOS (via Discover); Windows 10 and 11 are supported; macOS requires version 14 or newer.
Can I add games I didn't buy from these stores?Yes, Heroic lets you add games and applications from outside GOG, Epic and Amazon, as well as import an already installed game and define custom categories to organize your collection.
Does it help with game compatibility on Linux?Yes, it can search ProtonDB directly for a game and show ProtonDB and Steam Deck compatibility information right in the app, plus lets you download custom Wine and Proton versions.
Is Heroic available in languages other than English?Yes, the community has translated Heroic into almost 40 languages including Chinese, Japanese, Korean, Russian, French, German and many more, hosted on Weblate.
Can my existing Epic Games Store install be reused?Yes, Heroic can sync installed games with an existing Epic Games Store installation and also sync cloud saves.
Size
719 MB
Stars
12.4K
Age
5y
Commits · 90 Days