From 510d33c4e348a0d60e67c9658c686daca9eafa4c Mon Sep 17 00:00:00 2001 From: Stelios Tsampas Date: Sun, 23 Jun 2024 15:48:50 +0300 Subject: [PATCH] chore: update readme structure --- README.md | 95 +++++++++++++---------- docs/index.md | 208 +++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 262 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 75dc79e5..7bdae401 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # 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 +Rare is a graphical interface for Legendary, a command line alternative to Epic Games launcher, written in PyQt5
Logo @@ -13,6 +13,9 @@ Rare is a graphical interface for Legendary, a command line alternative to Epic licensed under CC BY-SA 4.0

+[![Discord Shield](https://discordapp.com/api/guilds/826881530310819914/widget.png?style=shield)](https://discord.gg/YvmABK9YSk) + + ## Why Rare? @@ -23,9 +26,11 @@ Rare is a graphical interface for Legendary, a command line alternative to Epic - Packages, packages everywhere + ## 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 +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 @@ -47,11 +52,35 @@ These are the logs for the main Rare application. As such are importand when Rar 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 +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 + ## 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 + ``` + +- Rare is available as a [Chocolatey package](https://community.chocolatey.org/packages/rare). You can install Rare with the following one-liner: + ```lang-default + choco install rare + ``` + + ### Linux #### Flatpak @@ -59,12 +88,18 @@ If you don't have a GitHub account or you just want to chat, you also can contac 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` +```sh +flatpak install flathub io.github.dummerle.rare +``` Run it via: +```sh +flatpak run io.github.dummerle.rare +``` -`flatpak run io.github.dummerle.rare` +### AppImage + +Available in [releases page](https://github.com/RareDevs/Rare/releases). #### Arch based @@ -87,38 +122,12 @@ There are some AUR packages available: There is a `.dmg` file available in [releases page](https://github.com/RareDevs/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. +**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 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: - - `winget install rare` - -- Rare is available as a [Chocolatey package](https://community.chocolatey.org/packages/rare). -You can install Rare with the following one-liner: - - `choco install rare` - -- We also have a beta tool for Windows: [Rare Updater](https://github.com/Dummerle/RareUpdater), which installs and updates rare with a single click - -### Packages - -In [releases page](https://github.com/RareDevs/Rare/releases), AppImages are available for Linux, a .msi file for windows and a .dmg -file for macOS. - ### Latest development version In the [actions](https://github.com/RareDevs/Rare/actions) tab you can find packages for the latest commits. @@ -133,10 +142,12 @@ Execute `pip install Rare` for all users, or `pip install Rare --user` for the c - Linux, macOS and FreeBSD: 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. +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**: -Depending on your operating system and the `python` distribution, the following paths might need to be in your environment's `PATH` +Depending on your operating system and the `python` distribution, the following paths might need to be in your +environment's `PATH` | OS | Path | |---------|--------------------------------------------| @@ -151,23 +162,24 @@ Depending on your operating system and the `python` distribution, the following 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 - ```shell + ```lang-default pip install -r requirements-full.txt ``` * If you are on Arch you can run - ```shell + ```lang-default sudo pacman --needed -S python-wheel python-setuptools python-pyqt5 python-qtawesome python-requests python-orjson ``` ``` yay -S legendary ``` * If you are on FreeBSD you have to install py39-qt5 from the packages - ```shell + ```lang-default sudo pkg install py39-qt5 ``` 4. Run `python3 -m rare` + ## Contributing There are several options to contribute. @@ -177,7 +189,10 @@ There are several options to contribute. More information is available in CONTRIBUTING.md. + + ## Screenshots + | Game covers | Vertical list | |----------------------------------------------|----------------------------------------------| | ![alt text](Screenshots/RareLibraryIcon.png) | ![alt text](Screenshots/RareLibraryList.png) | diff --git a/docs/index.md b/docs/index.md index 63725e74..cc36ca6e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1 +1,207 @@ -# This is a template for a GitHub page +# 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 PyQt5 + +
+ Logo +

Logo by @MultisampledNight available + here, + licensed under CC BY-SA 4.0

+
+ +[![Discord Shield](https://discordapp.com/api/guilds/826881530310819914/widget.png?style=shield)](https://discord.gg/YvmABK9YSk) + + + +## 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 + + + +## 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\\AppData\Local\Rare\Rare\cache\logs` | +| Linux | `/home//.cache/Rare/Rare/logs` | +| masOS | `/Users//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 + + + +## 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 + ``` + +- Rare is available as a [Chocolatey package](https://community.chocolatey.org/packages/rare). You can install Rare with the following one-liner: + ```lang-default + choco install rare + ``` + + +### Linux + +#### Flatpak + +Rare is available as a flatpak. See [rare](https://flathub.org/apps/details/io.github.dummerle.rare). + +Install it via: +```sh +flatpak install flathub io.github.dummerle.rare +``` + +Run it via: +```sh +flatpak run io.github.dummerle.rare +``` + +### 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 + +#### 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). + +**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`. + + +### Latest development version + +In the [actions](https://github.com/RareDevs/Rare/actions) 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. +- 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**: +Depending on your operating system and the `python` distribution, the following paths might need to be in your +environment's `PATH` + +| OS | Path | +|---------|--------------------------------------------| +| Windows | `\Scripts` | +| Linux | `/home//.local/bin` | +| masOS | `/Users//Library/Python/3.x/bin` | + + +### 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 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-pyqt5 python-qtawesome python-requests python-orjson + ``` + ``` + yay -S legendary + ``` + * 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` + + + +## 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. + + + +## Screenshots + +| Game covers | Vertical list | +|-------------------------------------------------|-------------------------------------------------| +| ![alt text](../Screenshots/RareLibraryIcon.png) | ![alt text](../Screenshots/RareLibraryList.png) | + +| Game details | Game settings | +|-------------------------------------------|-----------------------------------------------| +| ![alt text](../Screenshots/RareGameInfo.png) | ![alt text](../Screenshots/RareGameSettings.png) | + +| Downloads | Application settings | +|--------------------------------------------|-------------------------------------------| +| ![alt text](../Screenshots/RareDownloads.png) | ![alt text](../Screenshots/RareSettings.png) | +