Skip to content

Commit

Permalink
Other: Updated README it better instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
flavioislima committed Dec 31, 2020
1 parent 7fbeb0a commit 6de6285
Showing 1 changed file with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
# Heroic Games Launcher

This app is a native alternative to the Epic Games Launcher for Linux.
It uses the features implemented on [Legendary](https://github.com/derrod/legendary) but providing a GUI for it.
This app is GUI for the tool [Legendary](https://github.com/derrod/legendary), a native alternative to the Epic Games Launcher for Linux.

![heroic-library](https://user-images.githubusercontent.com/26871415/103409170-c68f6b00-4b65-11eb-8d79-ba5ae1a58e74.png)
![heroic-game](https://user-images.githubusercontent.com/26871415/103409190-e3c43980-4b65-11eb-8980-dd675420e867.png)

## Dependencies:
- [Legendary](https://github.com/derrod/legendary)
- Xterm (installed in most distros. I'll check the default terminal in the future)

## How to use it:
- Download the AppImage on the Releases Page
- Install legendary
- install xterm
- chmod +x heroic-xxx.AppImage
- ./heroic-xxx.AppImage
- If you neved used Legendary before, it will ask you to login first. So, two windows will be opened, a browser window will be opened on Epic Games Store for you to login there and get the SID code, and also a Xterm window will be opened and there you will paste the SID code.
- After the login, the app will refresh the game list and should relaunch showing your library. Sometime it won't then just close it and open it again.
- If you think is easier, before launching the app, run `legendary auth` on a terminal and after login run `legendary list-games`. Then the app will identify the configuration and will open your library.

## Feature availables right now
- Login with an existing Epic Games account
Expand Down Expand Up @@ -32,10 +45,14 @@ It uses the features implemented on [Legendary](https://github.com/derrod/legend
## How to build and run locally

This app uses web technologies like Electron, React and Typescript.
To be able to run you will need to have nodeJs installed locally.
To be able to run you will need to have NodeJs installed locally and follow the instructions below:

### Steps:
- Clone the Repository
- On the project folder run `npm install`
- Run `npm start`
- To build the binaries run `npm run dist`
- Clone the Repository.
- Install foreman with `npm i -g foreman`.
- On the project folder run `npm install`.
- For now, go to the `main.js` file in `/public` manually comment the `win.loadURL(file://...)` and uncoment `win.loadURL(http://localhost:3000)`. I'll add a env to check that soon as well.
- Uncomment `win.webContents.openDevTools()` to be able to check the result logs of the app.
- Run `npm run build` to build the React Assets.
- Run `npm start`.
- To build the binaries run `npm run dist`.

0 comments on commit 6de6285

Please sign in to comment.