diff --git a/README.md b/README.md index aa9a5bcb..f8b2419b 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,57 @@ # Rare -GUI for legendary. An Epic Games Launcher open source alternative +## A frontend for legendary, the open source Epic Games Launcher alternative -## This is a new version with better Styles. It has not many features, but i work on it. +Rare is currently considered beta software and in no way feature-complete. You will probably run into issues, so it is recommend to make a backup. If you have features you want to have in this app, create an issue on github, contact me on Discord (Dummerle#7419) or build it yourself. Please report bugs so I can fix them. +I work on a new and better version, with better style and better ui. If you are a designer and want to contribute, please contact me. You can test it in the branch "new-style", but it has just the basic features -It will take some time, because I want to reimplement some features on a smoother way. -### TODOS - - Sync Saves -- Game Settings -- Style Sheets -- Updates -- etc \ No newline at end of file +### Requirements + +- requests, +- pillow +- pyqt5 +- legendary-gl +- PyQtWebengine + +## Installation + +### Installation via pip (recommend) + +Execute *pip install Rare* for all users Or *pip install Rare --user* for only one user + +### Windows Simple + +Download Rare.exe and place it somewhere in PATH + +**Note** +Using the exe-file could cause an error with the stylesheets + +## Linux + +- For Arch Linux is an AUR package available: [rare-git](https://aur.archlinux.org/packages/rare-git) +- Other distributions have to install it with pip or clone the repo and install it manually: *python3 setup.py install* + + ## Issues + If you run in an issue with PyQtWebengine, try the branch "without-browser" + +## Implemented + +- Launch, install and uninstall games +- Authentication(Import from existing installation and via Browser) +- In-app Browser to buy games +- Settings (Legendary and games) +- Translations (English and German) + +## Planned +- Sync Cloud Saves +- Download Progressbar +- Offline mode +- More Translations + +## 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) + diff --git a/Screenshots/GameInfo.png b/Screenshots/GameInfo.png new file mode 100644 index 00000000..f4e73db1 Binary files /dev/null and b/Screenshots/GameInfo.png differ diff --git a/Screenshots/Rare.png b/Screenshots/Rare.png new file mode 100644 index 00000000..fa98f92c Binary files /dev/null and b/Screenshots/Rare.png differ diff --git a/Screenshots/RareSettings.png b/Screenshots/RareSettings.png new file mode 100644 index 00000000..74c82698 Binary files /dev/null and b/Screenshots/RareSettings.png differ