79 lines
3.4 KiB
Markdown
79 lines
3.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]
|
|
[![Merged PRs][prs-merged-image]][prs-merged-url]
|
|
[![GitHub contributors][contributors-image]][contributors-url]
|
|
[![License][license-image]][license-url]
|
|
[![Code style][code-style-image]][code-style-url]
|
|
|
|
[github-actions-url]: https://github.com/kra-mo/cartridges
|
|
[github-actions-image]: https://img.shields.io/github/actions/workflow/status/kra-mo/cartridges/flatpak-builder.yml?branch=main&label=Build
|
|
[prs-merged-url]: https://github.com/kra-mo/cartridges/pulls?q=is:pr+is:merged
|
|
[prs-merged-image]: https://img.shields.io/github/issues-pr-closed-raw/kra-mo/cartridges.svg?label=Merged+PRs&color=green
|
|
[contributors-url]: https://github.com/kra-mo/cartridges/graphs/contributors
|
|
[contributors-image]: https://img.shields.io/github/contributors-anon/kra-mo/cartridges.svg?label=Contributors
|
|
[license-url]: https://github.com/kra-mo/cartridges/blob/main/LICENSE
|
|
[license-image]: https://img.shields.io/github/license/kra-mo/cartridges?label=License
|
|
[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/projects/cartridges/cartridges
|
|
[weblate-image]: https://hosted.weblate.org/widgets/cartridges/-/cartridges/svg-badge.svg
|
|
|
|
<img src="data/screenshot.webp">
|
|
</div>
|
|
|
|
|
|
## The Project
|
|
Cartridges is a simple game launcher written in Python using GTK4 + Libadwaita.
|
|
### Features
|
|
- Manually adding and editing games
|
|
- Importing games from Steam, Heroic and Bottles
|
|
- Hiding games
|
|
- Searching and sorting by title, date added and last played
|
|
|
|
## Building
|
|
|
|
### GNOME Builder
|
|
|
|
1. Download [GNOME Builder](https://flathub.org/apps/details/org.gnome.Builder).
|
|
2. Click "Clone Repository" with `https://github.com/kra-mo/game-shelf.git` as the URL.
|
|
3. Click on the build button (hammer) at the top.
|
|
|
|
## Installation
|
|
|
|
### Latest Build From GitHub Actions
|
|
1. Install `org.gnome.Platform` from the [gnome-nightly repository](https://wiki.gnome.org/Apps/Nightly) if needed.
|
|
2. Download the artifact from the latest workflow run.
|
|
3. Decompress the archive.
|
|
4. Install it via GNOME Software or `flatpak install hu.kramo.Cartridges.flatpak`.
|
|
|
|
### From Releases
|
|
1. Install `org.gnome.Platform` from the [gnome-nightly repository](https://wiki.gnome.org/Apps/Nightly) if needed.
|
|
2. Download the latest release from Releases.
|
|
3. Install it via GNOME Software or `flatpak install hu.kramo.Cartridges.flatpak`.
|
|
|
|
### From GNOME Builder
|
|
Click the down arrow next to the hammer at the top of your GNOME Builder window, then click "Export". This will create a flatpak that then can be installed on your system.
|
|
|
|
## Contributing
|
|
|
|
### Code
|
|
Fork the repository, make your changes, then create a pull request.
|
|
|
|
### Translations
|
|
#### Weblate
|
|
The project can be translated on [Weblate](https://hosted.weblate.org/projects/cartridges/).
|
|
|
|
#### Manually
|
|
1. Clone the repository.
|
|
2. If it isn't already there, add your language to `/po/LINGUAS`.
|
|
3. Create a new translation from the `/po/cartridges.pot` file with a translation editor such as [Poedit](https://poedit.net/).
|
|
4. Save the file as `[YOUR LANGUAGE CODE].po` to `/po/`.
|
|
5. Create a pull request with your translations.
|