Skip to content
Merged
Changes from all commits
Commits
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
61 changes: 18 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
# Rare



## A frontend for legendary, the open source Epic Games Launcher alternative

Rare is a graphical interface for Legendary, a command line alternative to Epic Games launcher, written in PySide6

<div align="center">
<img src="https://github.com/RareDevs/Rare/blob/main/docs/assets/RareLogoWide.png?raw=true" alt="Logo" width="200"/>
<p><i>Logo by <a href="https://github.com/MultisampledNight">@MultisampledNight</a> available
<h2>Rare</h2>
<p>Logo by <a href="https://github.com/MultisampledNight">@MultisampledNight</a> available
<a href="https://github.com/RareDevs/Rare/blob/main/docs/assets/">here</a>,
licensed under CC BY-SA 4.0</i></p>
licensed under CC BY-SA 4.0</p>
<a href="https://discord.gg/YvmABK9YSk" target="_blank">
<img src="https://discordapp.com/api/guilds/826881530310819914/widget.png?style=shield" alt="Discord Shield">
</a>
</div>

[![Discord Shield](https://discordapp.com/api/guilds/826881530310819914/widget.png?style=shield)](https://discord.gg/YvmABK9YSk)


## What is Rare?
A graphical interface for Legendary, a command line alternative to Epic Games launcher, written in PySide6

## Why Rare?

Expand Down Expand Up @@ -94,7 +90,6 @@ There is also a semi-portable `.zip` archive in [releases page](https://github.c


### Linux

#### Flatpak

Rare is available as a flatpak. See [rare](https://flathub.org/apps/details/io.github.dummerle.rare).
Expand Down Expand Up @@ -122,16 +117,6 @@ 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

#### Debian based

- DUR package: [rare](https://mpr.hunterwittenborn.com/packages/rare)
- `.deb` file in [releases page](https://github.com/RareDevs/Rare/releases)

**Note**:
- pypresence is an optional package. You can install it from [DUR](https://mpr.hunterwittenborn.com/packages/python3-pypresence) or with pip.
- Some icons might look strange on Debian based distributions. The official python3-qtawesome package is too old.


### macOS

There is a `.dmg` file available in [releases page](https://github.com/RareDevs/Rare/releases).
Expand Down Expand Up @@ -178,31 +163,21 @@ environment's `PATH`


### Run from source
1. Clone the repo: `git clone https://github.com/RareDevs/Rare`.
2. Change your working directory to the project folder: `cd Rare`.
3. Run `pip install -r misc/requirements.in` to install all required dependencies.
4. Run `./tools/ui2py.sh --force`, `./tools/qrc2py.sh --force` and `./tools/ts2qm.py` to prepare the UI components.
5. Finally, run `pip install .`.
6. Run the application with `python3 -m rare`.

1. Clone the repo: `git clone https://github.com/RareDevs/Rare`
2. Change your working directory to the project folder: `cd Rare`
3. Run `pip install -r requirements.txt` to install all required dependencies.
* If you want to be able to use the automatic login and Discord pypresence, run
```lang-default
pip install -r requirements-full.txt
```
* If you are on Arch you can run
```lang-default
sudo pacman --needed -S python-wheel python-setuptools python-setuptools-scm python-pyside6 python-qtawesome python-requests python-orjson
```
```
yay -S legendary python-vdf
```
* If you are on FreeBSD you have to install py39-qt5 from the packages
```lang-default
sudo pkg install py39-qt5
```
4. Run `python3 -m rare`
#### In Arch Linux
You can run `sudo pacman --needed -S python-wheel python-setuptools python-setuptools-scm python-pyside6 python-qtawesome python-requests python-orjson` and `yay -S legendary python-vdf`.

#### For packaging
For build and install the package manually, run `python setup.py bdist_wheel` and `python -m installer dist/*.whl`.


## Contributing

There are several options to contribute.

- If you know Python and PyQt, you can implement new features (Some ideas are in the projects tab).
Expand Down
Loading