144 lines
5.1 KiB
Markdown
144 lines
5.1 KiB
Markdown
# Rare
|
|
[![Discord Shield](https://discordapp.com/api/guilds/826881530310819914/widget.png?style=shield)](https://discord.gg/YvmABK9YSk)
|
|
|
|
## 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, based on PyQt5
|
|
|
|
<div align="center">
|
|
<img src="https://github.com/Dummerle/Rare/blob/main/rare/resources/images/Rare_nonsquared.png?raw=true" alt="Logo" width="200"/>
|
|
<p><i>Logo by <a href="https://github.com/MultisampledNight">@MultisampledNight</a> available
|
|
<a href="https://github.com/Dummerle/Rare/blob/main/rare/resources/images/">here</a>,
|
|
licensed under CC BY-SA 4.0</i></p>
|
|
</div>
|
|
|
|
## 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
|
|
|
|
## Issues
|
|
|
|
If you run into any issues, please report it by creating an issue on GitHub or on Discord: https://discord.gg/YvmABK9YSk
|
|
|
|
## Installation
|
|
|
|
### Linux
|
|
|
|
#### Flatpak
|
|
|
|
Rare is available as a flatpak. See [rare](https://flathub.org/apps/details/io.github.dummerle.rare).
|
|
|
|
Install it via:
|
|
|
|
`flatpak install flathub io.github.dummerle.rare`
|
|
|
|
Run it via:
|
|
|
|
`flatpak run io.github.dummerle.rare`
|
|
|
|
#### 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 features, which are not in a stable release
|
|
|
|
#### Debian based
|
|
|
|
- DUR package: [rare](https://mpr.hunterwittenborn.com/packages/rare)
|
|
- .deb file in [releases page](https://github.com/Dummerle/Rare/releases)
|
|
|
|
**Note**:
|
|
|
|
- pypresence is an optional package. You can install it
|
|
from [DUR](https://mpr.hunterwittenborn.com/packages/python3-pypresence) or with pip.
|
|
- Do not wonder if some icons look strange, because the official python3-qtawesome package is too old. Many icons were
|
|
replaced.
|
|
|
|
|
|
### macOS
|
|
|
|
There is a .dmg file available in [releases page](https://github.com/Dummerle/Rare/releases).
|
|
|
|
**Note**: When you launch it, you will see an error, that the package is from an unknown source. You have to enable it
|
|
manually in `Settings -> Security and Privacy`. Otherwise, Gatekeeper will block Rare from running.
|
|
|
|
You can also use `pip`.
|
|
|
|
### Windows
|
|
|
|
- There is a small beta tool for Windows: [Rare Updater](https://github.com/Dummerle/RareUpdater), which installs and updates rare with a single click
|
|
|
|
- Rare is available as a [Chocolatey package](https://community.chocolatey.org/packages/rare) on Windows.
|
|
You can install rare with the following one-liner:
|
|
|
|
`choco install rare`
|
|
|
|
### Packages
|
|
|
|
In [releases page](https://github.com/Dummerle/Rare/releases), AppImages are available for Linux, a .msi file for windows and a .dmg
|
|
file for macOS.
|
|
|
|
### Latest packages
|
|
|
|
In the [actions](https://github.com/Dummerle/Rare/actions) tab you can find packages for the latest commits.
|
|
|
|
**Note**: They might be unstable.
|
|
|
|
### Installation via pip (platform independent)
|
|
|
|
Execute `pip install Rare` for all users, or `pip install Rare --user` for the current user only.
|
|
|
|
Linux and Mac: execute `rare` in your terminal.
|
|
|
|
Windows: execute `pythonw -m rare` in cmd
|
|
|
|
It is possible to create a desktop link, or a start menu link. Execute the command above with `--desktop-shortcut`
|
|
or `--startmenu-shortcut` option, alternatively you can create them in the settings.
|
|
|
|
**Note about $PATH**:
|
|
|
|
On Linux:
|
|
|
|
`/home/user/.local/bin` must be in your PATH.
|
|
|
|
On Windows:
|
|
|
|
`PythonInstallationDirectory\Scripts` must be in your PATH.
|
|
|
|
On Mac:
|
|
|
|
`/Users/user/Library/Python/3.x/bin` must be in your PATH.
|
|
|
|
|
|
### Run from source
|
|
|
|
1. Clone the repo: `git clone https://github.com/Dummerle/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, run `pip install -r optional_requirements.txt`
|
|
If you are on Arch you can
|
|
run `sudo pacman --needed -S python-wheel python-setuptools python-pyqt5 python-qtawesome python-requests python-psutil`
|
|
4. Run `python3 -m rare`
|
|
|
|
## 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).
|
|
- You can translate the application in your language: Check our [transifex](https://www.transifex.com/rare-1/rare) page
|
|
for that.
|
|
|
|
More information is available in CONTRIBUTING.md.
|
|
|
|
## Images
|
|
|
|
![alt text](https://github.com/Dummerle/Rare/blob/main/Screenshots/Rare.png?raw=true)
|
|
![alt text](https://github.com/Dummerle/Rare/blob/main/Screenshots/GameInfo.png?raw=true)
|
|
![alt text](https://github.com/Dummerle/Rare/blob/main/Screenshots/RareSettings.png?raw=true)
|
|
![alt text](https://github.com/Dummerle/Rare/blob/main/Screenshots/RareDownloads.png?raw=true)
|
|
![alt text](https://github.com/Dummerle/Rare/blob/main/Screenshots/GameSettings.png?raw=true)
|