Files
cartridges/README.md
2023-03-22 19:04:00 +01:00

63 lines
2.4 KiB
Markdown

<div align="center">
<img src="data/icons/hicolor/scalable/apps/hu.kramo.Cartridges.svg" width="128" height="128">
# Cartridges
A GTK4 + Libadwaita game launcher
[![Build status][github-actions-image]][github-actions-url]
[![Translation Status][weblate-image]][weblate-url]
[![License][license-image]][license-url]
[![Discord Chatroom][discord-image]][discord-url]
[![Code style][code-style-image]][code-style-url]
[github-actions-url]: https://github.com/kra-mo/cartridges
[github-actions-image]: https://github.com/kra-mo/cartridges/actions/workflows/flatpak-builder.yml/badge.svg
[license-url]: https://github.com/kra-mo/cartridges/blob/main/LICENSE
[license-image]: https://img.shields.io/github/license/kra-mo/cartridges
[code-style-url]: https://github.com/psf/black
[code-style-image]: https://img.shields.io/badge/code%20style-black-000000?style=flat
[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
<img src="data/screenshot.webp">
</div>
# The Project
Cartridges is a simple game launcher written in Python using GTK4 and Libadwaita.
## Features
- Manually adding and editing games
- Importing games from Steam, Heroic and Bottles
- Support for multiple Steam install locations
- Hiding games
- Searching and sorting by title, date added and last played
For updates and questions, join our [Discord server]([discord-url])!
# Installation
## Linux
### From Releases
1. Download the latest release from [Releases](https://github.com/kra-mo/cartridges/releases).
2. Install the downloaded file via GNOME Software or `flatpak install hu.kramo.Cartridges.flatpak`.
## 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.
## Building manually
See [Building](https://github.com/kra-mo/cartridges/blob/main/CONTRIBUTING.md#building).
# Contributing
See [CONTRIBUTING](https://github.com/kra-mo/cartridges/blob/main/CONTRIBUTING.md).
Thanks to [Weblate](https://weblate.org/) for hosting our translations!