Thanks to visit codestin.com
Credit goes to github.com

Skip to content

README: move screenshot higher and reporting issues to the bottom of the page #592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 24, 2025
Merged

README: move screenshot higher and reporting issues to the bottom of the page #592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 51 additions & 64 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,71 +13,38 @@
## What is Rare?
A graphical interface for Legendary, a command line alternative to Epic Games launcher, written in PySide6

## Why Rare?

## Why Rare?
- Runs natively, and supports most of the major platforms
- Gets out of your way when you don't need it, allowing you to enjoy your games
- Tries to be as lightweight as we can make it while still offering a feature-full experience
- Integrates seamlessly with legendary as both projects are developed in Python
- Packages, packages everywhere


## Screenshots
| Game covers | Vertical list |
|-----------------------------------------------|-----------------------------------------------|
| ![alt text](/docs/assets/RareLibraryIcon.png) | ![alt text](/docs/assets/RareLibraryList.png) |

## Reporting issues

If you run into any issues, you can report them by creating an issue on GitHub:
https://github.com/RareDevs/Rare/issues/new/choose

When reporting issues, it is helpful to also include the logs with your issue.
You can find the longs in the following locations depending on your operating system

| OS | Path |
|---------|----------------------------------------------------------|
| Windows | `C:\Users\<username>\AppData\Local\Rare\Rare\cache\logs` |
| Linux | `/home/<username>/.cache/Rare/Rare/logs` |
| macOS | `/Users/<username>/Library/Caches/Rare/Rare/logs` |

In these folders you will find files named like below

- `Rare_23-12-19--11-14.log`

These are the logs for the main Rare application. As such are importand when Rare itself is crashing.

- `RareLauncher_f4e0c1dff48749fa9145c1585699e276_23-12-17--19-53.log`

These are the logs for each of the games you run through Rare. Rare uses a separate instance of itself
to launch games, and these are the logs of that instance.

If you don't have a GitHub account or you just want to chat, you also can contact us on Discord:
https://discord.gg/YvmABK9YSk


## Common issues
* If you are using multiple accounts, there is a chance that at some point you will not be able to log in into your account and see something like the following.
> Login failed. Decryption of EPIC launcher user information failed.

In that case navigate to one of the following directorories depending on your operating system and delete `user.json`
| Game details | Game settings |
|--------------------------------------------|------------------------------------------------|
| ![alt text](/docs/assets/RareGameInfo.png) | ![alt text](/docs/assets/RareGameSettings.png) |

| OS | Path |
|---------|------------------------------------|
| Windows | `%USERPROFILE%\.config\legendary\` |
| Linux | `$HOME/.config/legendary/` |
| macOS | `$HOME/.config/legendary/` |
| Downloads | Application settings |
|---------------------------------------------|--------------------------------------------|
| ![alt text](/docs/assets/RareDownloads.png) | ![alt text](/docs/assets/RareSettings.png) |


## Installation


### Windows

There is an `.msi` installer available in [releases page](https://github.com/RareDevs/Rare/releases).

There is also a semi-portable `.zip` archive in [releases page](https://github.com/RareDevs/Rare/releases) that lets you run Rare without installing it.

**Important**: On recent version of Windows you should have MSVC 2015 installed, you can get it from [here](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist?view=msvc-170#visual-studio-2015-2017-2019-and-2022)

#### Packages

- Rare is available as a [Winget package](https://github.com/microsoft/winget-pkgs/tree/master/manifests/d/Dummerle/Rare). You can install Rare with the following one-liner:
```lang-default
winget install rare
Expand All @@ -88,10 +55,12 @@ There is also a semi-portable `.zip` archive in [releases page](https://github.c
choco install rare
```


### Linux
#### Flatpak
### AppImage

Available in [releases page](https://github.com/RareDevs/Rare/releases).

#### Flatpak
Rare is available as a flatpak. See [rare](https://flathub.org/apps/details/io.github.dummerle.rare).

Install it via:
Expand All @@ -106,19 +75,13 @@ flatpak run io.github.dummerle.rare

Alternatively, you can download the flatpak package from [our repository](https://github.com/RareDevs/io.github.dummerle.rare/releases)

### AppImage

Available in [releases page](https://github.com/RareDevs/Rare/releases).

#### Arch based

There are some AUR packages available:

- [rare](https://aur.archlinux.org/packages/rare) - for stable releases
- [rare-git](https://aur.archlinux.org/packages/rare-git) - for the latest development version

### macOS

There is a `.dmg` file available in [releases page](https://github.com/RareDevs/Rare/releases).

Rare's macOS binaries are currently not singed and because of that when you launch Rare, you will see an error,
Expand All @@ -135,14 +98,12 @@ Alternatively, you can install using `pip`/`pipx` or from source.


### Latest development version

In the [actions](https://github.com/RareDevs/Rare/actions/workflows/snapshot.yml) tab you can find packages for the latest commits.

**Note**: They might be unstable and likely broken.


### Installation via pip (platform independent)

Execute `pip install Rare` for all users, or `pip install Rare --user` for the current user only.

- Linux, macOS and FreeBSD: execute `rare` in your terminal.
Expand Down Expand Up @@ -186,17 +147,43 @@ There are several options to contribute.
More information is available in CONTRIBUTING.md.


## Screenshots
## Reporting issues
If you run into any issues, you can report them by creating an issue on GitHub:
https://github.com/RareDevs/Rare/issues/new/choose

| Game covers | Vertical list |
|-----------------------------------------------|----------------------------------------------|
| ![alt text](/docs/assets/RareLibraryIcon.png) | ![alt text](/docs/assets/RareLibraryList.png) |
When reporting issues, it is helpful to also include the logs with your issue.
You can find the longs in the following locations depending on your operating system

| Game details | Game settings |
|-------------------------------------------|-----------------------------------------------|
| ![alt text](/docs/assets/RareGameInfo.png) | ![alt text](/docs/assets/RareGameSettings.png) |
| OS | Path |
|---------|----------------------------------------------------------|
| Windows | `C:\Users\<username>\AppData\Local\Rare\Rare\cache\logs` |
| Linux | `/home/<username>/.cache/Rare/Rare/logs` |
| macOS | `/Users/<username>/Library/Caches/Rare/Rare/logs` |

| Downloads | Application settings |
|--------------------------------------------|-------------------------------------------|
| ![alt text](/docs/assets/RareDownloads.png) | ![alt text](/docs/assets/RareSettings.png) |
In these folders you will find files named like below

- `Rare_23-12-19--11-14.log`

These are the logs for the main Rare application. As such are importand when Rare itself is crashing.

- `RareLauncher_f4e0c1dff48749fa9145c1585699e276_23-12-17--19-53.log`

These are the logs for each of the games you run through Rare. Rare uses a separate instance of itself
to launch games, and these are the logs of that instance.

If you don't have a GitHub account or you just want to chat, you also can contact us on Discord:
https://discord.gg/YvmABK9YSk


## Common issues
* If you are using multiple accounts, there is a chance that at some point you will not be able to log in into your account and see something like the following.
> Login failed. Decryption of EPIC launcher user information failed.

In that case navigate to one of the following directorories depending on your operating system and delete `user.json`

| OS | Path |
|---------|------------------------------------|
| Windows | `%USERPROFILE%\.config\legendary\` |
| Linux | `$HOME/.config/legendary/` |
| macOS | `$HOME/.config/legendary/` |

27 changes: 6 additions & 21 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,16 @@
## What is Rare?
A graphical interface for Legendary, a command line alternative to Epic Games launcher, written in PySide6

## Why Rare?

## Why Rare?
- Runs natively, and supports most of the major platforms
- Gets out of your way when you don't need it, allowing you to enjoy your games
- Tries to be as lightweight as we can make it while still offering a feature-full experience
- Integrates seamlessly with legendary as both projects are developed in Python
- Packages, packages everywhere



## Screenshots

| Game covers | Vertical list |
|-----------------------------------------------|-----------------------------------------------|
| ![alt text](/Rare/assets/RareLibraryIcon.png) | ![alt text](/Rare/assets/RareLibraryList.png) |
Expand All @@ -38,21 +36,15 @@ A graphical interface for Legendary, a command line alternative to Epic Games la
| ![alt text](/Rare/assets/RareDownloads.png) | ![alt text](/Rare/assets/RareSettings.png) |




## Installation


### Windows

There is an `.msi` installer available in [releases page](https://github.com/RareDevs/Rare/releases).

There is also a semi-portable `.zip` archive in [releases page](https://github.com/RareDevs/Rare/releases) that lets you run Rare without installing it.

**Important**: On recent version of Windows you should have MSVC 2015 installed, you can get it from [here](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist?view=msvc-170#visual-studio-2015-2017-2019-and-2022)

#### Packages

- Rare is available as a [Winget package](https://github.com/microsoft/winget-pkgs/tree/master/manifests/d/Dummerle/Rare). You can install Rare with the following one-liner:
```lang-default
winget install rare
Expand All @@ -63,10 +55,12 @@ There is also a semi-portable `.zip` archive in [releases page](https://github.c
choco install rare
```


### Linux
#### Flatpak
### AppImage

Available in [releases page](https://github.com/RareDevs/Rare/releases).

#### Flatpak
Rare is available as a flatpak. See [rare](https://flathub.org/apps/details/io.github.dummerle.rare).

Install it via:
Expand All @@ -81,19 +75,13 @@ flatpak run io.github.dummerle.rare

Alternatively, you can download the flatpak package from [our repository](https://github.com/RareDevs/io.github.dummerle.rare/releases)

### AppImage

Available in [releases page](https://github.com/RareDevs/Rare/releases).

#### Arch based

There are some AUR packages available:

- [rare](https://aur.archlinux.org/packages/rare) - for stable releases
- [rare-git](https://aur.archlinux.org/packages/rare-git) - for the latest development version

### macOS

There is a `.dmg` file available in [releases page](https://github.com/RareDevs/Rare/releases).

Rare's macOS binaries are currently not singed and because of that when you launch Rare, you will see an error,
Expand All @@ -110,14 +98,12 @@ Alternatively, you can install using `pip`/`pipx` or from source.


### Latest development version

In the [actions](https://github.com/RareDevs/Rare/actions/workflows/snapshot.yml) tab you can find packages for the latest commits.

**Note**: They might be unstable and likely broken.


### Installation via pip (platform independent)

Execute `pip install Rare` for all users, or `pip install Rare --user` for the current user only.

- Linux, macOS and FreeBSD: execute `rare` in your terminal.
Expand Down Expand Up @@ -162,7 +148,6 @@ More information is available in CONTRIBUTING.md.


## Reporting issues

If you run into any issues, you can report them by creating an issue on GitHub:
https://github.com/RareDevs/Rare/issues/new/choose

Expand All @@ -180,7 +165,7 @@ In these folders you will find files named like below
- `Rare_23-12-19--11-14.log`

These are the logs for the main Rare application. As such are importand when Rare itself is crashing.

- `RareLauncher_f4e0c1dff48749fa9145c1585699e276_23-12-17--19-53.log`

These are the logs for each of the games you run through Rare. Rare uses a separate instance of itself
Expand Down
Loading