Files
cartridges/README.md
2024-04-03 16:06:27 +02:00

102 lines
3.3 KiB
Markdown

[circle-url]: https://circle.gnome.org
[circle-image]: https://circle.gnome.org/assets/button/badge.svg
[weblate-url]: https://hosted.weblate.org/engage/cartridges/
[weblate-image]: https://hosted.weblate.org/widgets/cartridges/-/cartridges/svg-badge.svg
[discord-url]: https://discord.gg/4KSFh3AmQR
[discord-image]: https://img.shields.io/discord/1088155799299313754?color=%235865F2&label=discord&logo=discord&logoColor=%23FFFFFF&style=for-the-badge
[matrix-url]: https://matrix.to/#/#cartridges:matrix.org
[matrix-image]: https://img.shields.io/matrix/cartridges:matrix.org?label=Matrix&logo=matrix&color=%230dbd8b&style=for-the-badge
[flathub-url]: https://flathub.org/apps/page.kramo.Cartridges
[flathub-image]: https://img.shields.io/flathub/v/page.kramo.Cartridges?logo=flathub&style=for-the-badge
[installs-image]: https://img.shields.io/flathub/downloads/page.kramo.Cartridges?style=for-the-badge
<div align="center">
<img src="data/icons/hicolor/scalable/apps/page.kramo.Cartridges.svg" width="128" height="128">
# Cartridges
A GTK4 + Libadwaita game launcher
[![GNOME Circle][circle-image]][circle-url]
[![Translation Status][weblate-image]][weblate-url]
[![Flathub][flathub-image]][flathub-url]
[![Discord][discord-image]][discord-url]
[![Matrix][matrix-image]][matrix-url]
[![Installs][installs-image]][flathub-url]
<img src="data/screenshots/1.png">
</div>
# The Project
Cartridges is an easy-to-use, elegant game launcher written in Python using GTK4 and Libadwaita.
## Features
- Manually adding and editing games
- Importing games from various sources:
- Steam
- Lutris
- Heroic
- Bottles
- itch
- Legendary
- RetroArch
- Flatpak
- Desktop Entries
- Filtering games by source
- Searching and sorting by title, date added and last played
- Hiding games
- Automatically downloading cover art from [SteamGridDB](https://www.steamgriddb.com/)
- Searching for games on various databases
- Animated covers
- A search provider for GNOME
For updates and questions, join our [Discord server][discord-url] (bridged to [Matrix](https://matrix.to/#/#cartridges:matrix.org))!
## Donations
I accept donations through [GitHub Sponsors](https://github.com/sponsors/kra-mo).
Thank you for your generosity! 💜
# Installation
## Linux
### Flathub
The app is available on Flathub.
<a href=https://flathub.org/apps/page.kramo.Cartridges><img width='240' alt='Download on Flathub' src='https://dl.flathub.org/assets/badges/flathub-badge-en.png'/></a>
## Windows
### From Releases
1. Download the latest release from [Releases](https://github.com/kra-mo/cartridges/releases).
2. Run the downloaded installer.
Note: Windows might present you with a warning when trying to install the app. This is expected, just ignore the warning.
### Winget
Install the latest release with the command: `winget install cartridges`.
## Building manually
See [Building](https://github.com/kra-mo/cartridges/blob/main/CONTRIBUTING.md#building).
# Contributing
See [CONTRIBUTING.md](https://github.com/kra-mo/cartridges/blob/main/CONTRIBUTING.md).
Thanks to [Weblate](https://weblate.org/) for hosting our translations!
# Code of Conduct
The project follows the [GNOME Code of Conduct](https://conduct.gnome.org/).
See [CODE_OF_CONDUCT.md](https://github.com/kra-mo/cartridges/blob/main/CODE_OF_CONDUCT.md).