Rare


NameRare JSON
Version 1.10.11 PyPI version JSON
download
home_pagehttps://github.com/Dummerle/Rare
SummaryA gui for Legendary
upload_time2023-12-25 13:57:31
maintainer
docs_urlNone
authorDummerle
requires_python>=3.9
licenseGPL-3
keywords
VCS
bugtrack_url
requirements requests PyQt5 QtAwesome setuptools legendary-gl orjson vdf pywin32
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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


## Reporing 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`                 |
| masOS   | `/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


## 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 development version

#### 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.
- 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/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 an `.msi` installer available in [releases page](https://github.com/Dummerle/Rare/releases).

There is also a semi-portable `.zip` archive in [releases page](https://github.com/Dummerle/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/Dummerle/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/Dummerle/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 | `<python_installation_folder>\Scripts`     |
| Linux   | `/home/<username>/.local/bin`              |
| masOS   | `/Users/<username>/Library/Python/3.x/bin` |


### 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 and Discord pypresence, run `pip install -r requirements-full.txt`
   * If you are on Arch you can run `sudo pacman --needed -S python-wheel python-setuptools python-pyqt5 python-qtawesome python-requests python-orjson` and `yay -S legendary`
   * If you are on FreeBSD you have to install py39-qt5 from the packages: `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.

## 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)



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Dummerle/Rare",
    "name": "Rare",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "",
    "author": "Dummerle",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/39/28/9b249befc6637cb60e964a55a91b60c87da51d1543f5f3c8a13559649114/Rare-1.10.11.tar.gz",
    "platform": null,
    "description": "# Rare\n[![Discord Shield](https://discordapp.com/api/guilds/826881530310819914/widget.png?style=shield)](https://discord.gg/YvmABK9YSk)\n\n\n## A frontend for legendary, the open source Epic Games Launcher alternative\n\nRare is a graphical interface for Legendary, a command line alternative to Epic Games launcher, based on PyQt5\n\n<div align=\"center\">\n    <img src=\"https://github.com/Dummerle/Rare/blob/main/rare/resources/images/Rare_nonsquared.png?raw=true\" alt=\"Logo\" width=\"200\"/>\n    <p><i>Logo by <a href=\"https://github.com/MultisampledNight\">@MultisampledNight</a> available\n        <a href=\"https://github.com/Dummerle/Rare/blob/main/rare/resources/images/\">here</a>,\n        licensed under CC BY-SA 4.0</i></p>\n</div>\n\n\n## Why Rare?\n\n- Runs natively, and supports most of the major platforms\n- Gets out of your way when you don't need it, allowing you to enjoy your games\n- Tries to be as lightweight as we can make it while still offering a feature-full experience\n- Integrates seamlessly with legendary as both projects are developed in Python\n- Packages, packages everywhere\n\n\n## Reporing issues\n\nIf you run into any issues, you can report them by creating an issue on GitHub: https://github.com/RareDevs/Rare/issues/new/choose\n\nWhen reporting issues, it is helpful to also include the logs with your issue.\nYou can find the longs in the following locations depending on your operating system\n\n| OS      | Path                                                     |\n|---------|----------------------------------------------------------|\n| Windows | `C:\\Users\\<username>\\AppData\\Local\\Rare\\Rare\\cache\\logs` |\n| Linux   | `/home/<username>/.cache/Rare/Rare/logs`                 |\n| masOS   | `/Users/<username>/Library/Caches/Rare/Rare/logs`        |\n\nIn these folders you will find files named like below\n\n- `Rare_23-12-19--11-14.log`\n\nThese are the logs for the main Rare application. As such are importand when Rare itself is crashing.\n \n- `RareLauncher_f4e0c1dff48749fa9145c1585699e276_23-12-17--19-53.log`\n\nThese are the logs for each of the games you run through Rare. Rare uses a separate instance of itself\nto launch games, and these are the logs of that instance.\n\nIf you don't have a GitHub account or you just want to chat, you also can contact us on Discord: https://discord.gg/YvmABK9YSk\n\n\n## Installation\n\n### Linux\n\n#### Flatpak\n\nRare is available as a flatpak. See [rare](https://flathub.org/apps/details/io.github.dummerle.rare).\n\nInstall it via:\n\n`flatpak install flathub io.github.dummerle.rare`\n\nRun it via:\n\n`flatpak run io.github.dummerle.rare`\n\n#### Arch based\n\nThere are some AUR packages available:\n\n- [rare](https://aur.archlinux.org/packages/rare) - for stable releases\n- [rare-git](https://aur.archlinux.org/packages/rare-git) - for the latest development version\n\n#### Debian based\n\n- DUR package: [rare](https://mpr.hunterwittenborn.com/packages/rare)\n- `.deb` file in [releases page](https://github.com/Dummerle/Rare/releases)\n\n**Note**:\n- pypresence is an optional package. You can install it from [DUR](https://mpr.hunterwittenborn.com/packages/python3-pypresence) or with pip.\n- Some icons might look strange on Debian based distributions. The official python3-qtawesome package is too old.\n\n\n### macOS\n\nThere is a `.dmg` file available in [releases page](https://github.com/Dummerle/Rare/releases).\n\n**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.\n\nYou can also use `pip`.\n\n\n### Windows\n\nThere is an `.msi` installer available in [releases page](https://github.com/Dummerle/Rare/releases).\n\nThere is also a semi-portable `.zip` archive in [releases page](https://github.com/Dummerle/Rare/releases) that lets you run Rare without installing it.\n\n**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)\n\n#### Packages\n\n- Rare is available as a [Winget package](https://github.com/microsoft/winget-pkgs/tree/master/manifests/d/Dummerle/Rare)\nYou can install Rare with the following one-liner:\n\n    `winget install rare`\n\n- Rare is available as a [Chocolatey package](https://community.chocolatey.org/packages/rare).\nYou can install Rare with the following one-liner:\n\n    `choco install rare`\n\n- We also have a beta tool for Windows: [Rare Updater](https://github.com/Dummerle/RareUpdater), which installs and updates rare with a single click\n\n### Packages\n\nIn [releases page](https://github.com/Dummerle/Rare/releases), AppImages are available for Linux, a .msi file for windows and a .dmg\nfile for macOS.\n\n### Latest development version\n\nIn the [actions](https://github.com/Dummerle/Rare/actions) tab you can find packages for the latest commits.\n\n**Note**: They might be unstable and likely broken.\n\n\n### Installation via pip (platform independent)\n\nExecute `pip install Rare` for all users, or `pip install Rare --user` for the current user only.\n\n- Linux, macOS and FreeBSD: execute `rare` in your terminal.\n- Windows: execute `pythonw -m rare` in cmd\n\nIt 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.\n\n**Note about $PATH**:\nDepending on your operating system and the `python` distribution, the following paths might need to be in your environment's `PATH`\n\n| OS      | Path                                       |\n|---------|--------------------------------------------|\n| Windows | `<python_installation_folder>\\Scripts`     |\n| Linux   | `/home/<username>/.local/bin`              |\n| masOS   | `/Users/<username>/Library/Python/3.x/bin` |\n\n\n### Run from source\n\n1. Clone the repo: `git clone https://github.com/Dummerle/Rare\n2. Change your working directory to the project folder: `cd Rare`\n3. Run `pip install -r requirements.txt` to install all required dependencies.\n   * If you want to be able to use the automatic login and Discord pypresence, run `pip install -r requirements-full.txt`\n   * If you are on Arch you can run `sudo pacman --needed -S python-wheel python-setuptools python-pyqt5 python-qtawesome python-requests python-orjson` and `yay -S legendary`\n   * If you are on FreeBSD you have to install py39-qt5 from the packages: `sudo pkg install py39-qt5`\n4. Run `python3 -m rare`\n\n\n## Contributing\n\nThere are several options to contribute.\n\n- If you know Python and PyQt, you can implement new features (Some ideas are in the projects tab).\n- You can translate the application in your language: Check our [transifex](https://www.transifex.com/rare-1/rare) page for that.\n\nMore information is available in CONTRIBUTING.md.\n\n## Images\n\n![alt text](https://github.com/Dummerle/Rare/blob/main/Screenshots/Rare.png?raw=true)\n![alt text](https://github.com/Dummerle/Rare/blob/main/Screenshots/GameInfo.png?raw=true)\n![alt text](https://github.com/Dummerle/Rare/blob/main/Screenshots/RareSettings.png?raw=true)\n![alt text](https://github.com/Dummerle/Rare/blob/main/Screenshots/RareDownloads.png?raw=true)\n![alt text](https://github.com/Dummerle/Rare/blob/main/Screenshots/GameSettings.png?raw=true)\n\n\n",
    "bugtrack_url": null,
    "license": "GPL-3",
    "summary": "A gui for Legendary",
    "version": "1.10.11",
    "project_urls": {
        "Homepage": "https://github.com/Dummerle/Rare"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b3ccb63e8495f82b55e07797eeea3c288c89fb947d4a5851732dba5a686fcf99",
                "md5": "a07ab585feca0cb26235345e25d24b07",
                "sha256": "48fc6fa0d283c2a0cd3662b2e9b724fdc0c2f58aebd05ece0a54bf1ac7d27d23"
            },
            "downloads": -1,
            "filename": "Rare-1.10.11-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a07ab585feca0cb26235345e25d24b07",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 3646339,
            "upload_time": "2023-12-25T13:57:29",
            "upload_time_iso_8601": "2023-12-25T13:57:29.247919Z",
            "url": "https://files.pythonhosted.org/packages/b3/cc/b63e8495f82b55e07797eeea3c288c89fb947d4a5851732dba5a686fcf99/Rare-1.10.11-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "39289b249befc6637cb60e964a55a91b60c87da51d1543f5f3c8a13559649114",
                "md5": "91cef99549966dadfc9f61fd69958d20",
                "sha256": "ff0a43daaf06ae2dad50bc90fae2aadf6c154d8e558d9941d18238e4cd902b09"
            },
            "downloads": -1,
            "filename": "Rare-1.10.11.tar.gz",
            "has_sig": false,
            "md5_digest": "91cef99549966dadfc9f61fd69958d20",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 3487643,
            "upload_time": "2023-12-25T13:57:31",
            "upload_time_iso_8601": "2023-12-25T13:57:31.032017Z",
            "url": "https://files.pythonhosted.org/packages/39/28/9b249befc6637cb60e964a55a91b60c87da51d1543f5f3c8a13559649114/Rare-1.10.11.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-25 13:57:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Dummerle",
    "github_project": "Rare",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "requests",
            "specs": []
        },
        {
            "name": "PyQt5",
            "specs": []
        },
        {
            "name": "QtAwesome",
            "specs": []
        },
        {
            "name": "setuptools",
            "specs": []
        },
        {
            "name": "legendary-gl",
            "specs": [
                [
                    ">=",
                    "0.20.34"
                ]
            ]
        },
        {
            "name": "orjson",
            "specs": []
        },
        {
            "name": "vdf",
            "specs": []
        },
        {
            "name": "pywin32",
            "specs": []
        }
    ],
    "lcname": "rare"
}
        
Elapsed time: 0.17330s