adityaruplaha/HeroicGamesLauncher

A Native GUI Epic Games Launcher for Linux

Heroic Games Launcher

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 and GOG Games using our custom implementation with gogdl. Heroic is built with Web Technologies like: TypeScript, React, NodeJS and Electron.

Index

• Heroic Games Launcher
  • Index
  • Features available right now
  • Planned features
  • Supported Operating Systems
  • Language Support
    • Help with Translations Here
  • Installation
    • Linux
      • Flatpak
      • Debian, Ubuntu and Derivatives
      • Debian (third party apt repository)
      • Arch (AUR)
      • Fedora
      • Other Distributions (AppImage and TAR.XZ)
    • Windows
    • macOS
    • Build binaries locally (All platforms)
    • Any OS (development environment)
    • Building with VS Code
    • Development Using a Container
    • Any OS (development environment)
    • Building with VS Code
    • Development Using a Container
  • Screenshots
  • Credits

Features available right now

• Login with an existing Epic Games account or GOG account
• Install, uninstall, update, repair and move Games
• Import an already installed game
• Play Epic games online [AntiCheat on macOS and on Linux depends on the game]
• Play games using Wine or Proton [Linux]
• Play games using Crossover [macOS]
• Download custom Wine and Proton versions [Linux]
• Access to Epic and GOG stores directly from Heroic
• Search for the game on ProtonDB for compatibility information [Linux]
• Sync installed games with an existing Epic Games Store installation
• Sync saves with the cloud
• Theming Support

Planned features

• Download queue
• Add Games outside GOG and Epic Games
• Support Other Store (Amazon Gaming, IndieGala, etc)
• Play GOG games online

Supported Operating Systems

• Linux:
  • Ubuntu 20.04LTS or newer
  • Fedora 33 or newer
  • Arch Linux (Manjaro and Garuda as well)
  • Heroic will still work on most distros but we do not give official support for them. So do not open Issues here in these cases, instead, open a Discussion or try our Discord.
• SteamOS (downloading using Discover only)
• Windows 8+ (might work on Win7 if you have the latest PowerShell but we do not give support for it)
• macOS 10.15 or higher

Language Support

• English
• Bulgarian
• Catalan
• Czech
• Croatian
• Simplified Chinese
• Traditional Chinese
• Dutch
• Estonian
• Finnish
• French
• German
• Greek
• Korean
• Hungarian
• Italian
• Indonesian
• Malayalam
• Persian
• Polish
• Portuguese
• Portuguese (Brazil)
• Romanian
• Russian
• Spanish
• Swedish
• Tamil
• Turkish
• Ukrainian
• Vietnamese

Help with Translations Here

Installation

Linux

Flatpak

Heroic is available on Flathub, so should be on most distros when using Software Centers like Pop_OS! Store or Discover. But can also be accessed here

Debian, Ubuntu and Derivatives

Download the heroic_x.x.x_amd64.deb from the Releases section

sudo dpkg -i heroic_x.x.x_amd64.deb

Debian/Ubuntu (third party apt repository)

You can add the Raul Dipeas personal apt repository:

bash <(wget -qO- https://raw.githubusercontent.com/Heroic-Games-Launcher/HeroicGamesLauncher/main/rauldipeas.sh)

If you need support on it, talk to Raul Dipeas on Twitter.

Arch (AUR)

AUR page: https://aur.archlinux.org/packages/heroic-games-launcher-bin/

To install it manually use:

git clone https://aur.archlinux.org/heroic-games-launcher-bin.git

cd heroic-games-launcher-bin

makepkg --cleanbuild --syncdeps --install --clean --rmdeps

Otherwise you can install it via your prefered AUR helper, e.g. yay.

Fedora

Heroic for Fedora is available on the COPR repo or as the binary on the releases page.

Other Distributions (AppImage and TAR.XZ)

Download the heroic-x.x.x.AppImage or heroic-x.x.x.tar.xz from the Releases section. Make sure you have Curl and Gawk, normally it comes with most distros but check for them if you have any issue.

To make the AppImage it executable use:

chmod +x heroic-x.x.x.AppImage

To run it use:

./heroic-x.x.x.AppImage

For the tar.xz file, you need first to extract it somewhere, enter the folder and run:

chmod +x heroic

To run it use:

./heroic

Windows

If you use WinGet, just type: winget install HeroicGamesLauncher.HeroicGamesLauncher. otherwise download Heroic.Setup.x.x.x.exe or the Portable Heroic-x.x.x.exe file and run it. It will install it to the start menu and desktop, use those to run it.

macOS

If you use Homebrew, just type: brew install --cask heroic. Otherwise, download Heroic-x.x.x.dmg and move the Heroic App to the Applications folder.

Build binaries locally (All platforms)

• All Platforms: Requires NodeJS to build
  Use yarn or npm

git clone https://github.com/Heroic-Games-Launcher/HeroicGamesLauncher.git

cd HeroicGamesLauncher

• Build for Linux:

yarn

yarn dist:linux {package to create} (eg: deb, pacman, tar.xz, rpm, AppImage)

• Build for Windows (Beta):

yarn.cmd (or npm install)

yarn.cmd (or npm run) dist:win

• Build for Mac (Alpha):

yarn (or npm install)

yarn (or npm run) dist:mac

Any OS (development environment)

1. Download Yarn and Node.js
2. Download the dependencies with yarn
3. Go to the debug tab on vscode and start the two tasks, 'Start renderer process' and 'Debug main process' or yarn react-start && yarn electron

Building with VS Code

1. Download Yarn and Node.js
2. Download the dependencies with yarn
3. Open the tasks. Select "Build with [your OS]"

Development Using a Container

If you would prefer, we have a docker container defined to develop / build Heroic with (a potential reason being to avoid loading tons of dependencies on your host filesystem). There are two methods, based on whether you use VS Code.

VS Code

There is a .devcontainer directory containing a definition that VS Code will recognize for automatically opening your local Heroic directory in a container in VS Code.

NOTE: this requires that you install the 'Remote - Containers' extension.

1. Open the root of your local Heroic directory in VS Code.
2. You should get a prompt in the bottom right to build and open the project in the dev container.
3. If the above prompt does not occur, on the bottom left, there is a green icon that should be there if the remote extension is installed. Click on it, and select "Reopen in container".
4. The bottom left green icon should now say: "Dev Container: Heroic Games Launcher".

After the container's package manager runs, open a new terminal session and you should be able to run bash commands from within the container. Any yarn dist:linux builds should also now show up on your host filesystem.

Manually Building the Docker Image

If you don't use VS Code or don't want it integrated with the container, you can build and run the container manually using either Docker or Podman.

1. From the root of your local Heroic directory, run:

docker build -t heroicdevcontainer -f Dockerfile .

2. Assuming all went well, you can now enter the container:

docker run -it -v ./:/tmp/heroic localhost/heroicdevcontainer:latest

3. The above command will mount your local Heroic dir to /tmp/heroic in the container (unless you used a different path).

cd /tmp/heroic

And you should be good to go, code and build away!

Sponsors

Screenshots

Credits

Weblate: Localization platform

• URL: https://weblate.org/en/

Those Awesome Guys: Gamepad prompts images

• URL: https://thoseawesomeguys.com/prompts/