Metadata-Version: 2.4
Name: geode-gem
Version: 1.0.0
Summary: Geode-Gem is an interface to manage emulators and games
Maintainer-email: PacMiam <pacmiam@kawateam.dev>
Project-URL: Archives, https://archives.kawateam.dev/geode-gem/
Project-URL: Homepage, https://geode.kawateam.dev/
Project-URL: Sources, https://laboratory.kawateam.dev/Geode/gem
Project-URL: Tracker, https://laboratory.kawateam.dev/Geode/gem/issues
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: X11 Applications :: GTK
Classifier: Intended Audience :: End Users/Desktop
Classifier: Natural Language :: French
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Description-Content-Type: text/org
License-File: LICENSE
Requires-Dist: pygobject~=3.50
Requires-Dist: pyxdg~=0.28
Provides-Extra: dev
Requires-Dist: black==25.9.0; extra == "dev"
Requires-Dist: build==1.4.3; extra == "dev"
Requires-Dist: coverage==7.8.2; extra == "dev"
Requires-Dist: nox==2026.04.10; extra == "dev"
Requires-Dist: pytest==8.4.2; extra == "dev"
Requires-Dist: flake8==7.3.0; extra == "dev"
Dynamic: license-file

-*- mode: org -*-

[[https://geode.kawateam.dev][Geode-Gem]] is a graphical interface made with Python and Gtk+3 for the GNU/Linux
system. It was designed to manage collection of games without the burden to
add each game one by one.

[[file:docs/preview.jpg]]

Geode-Gem took his inspiration from the [[https://gelide.sourceforge.net/][Gelide]] software by Juan Ángel Moreno
Fernández.

* Political note

This project was made by a living creature since the very first commit and will
stay like this until the end of this universe.

Any slop, llm-garbage or far-right contents will not be tolerated in this
project and will be banned.

* Requirements

This application was made with Python 3 and Gtk+3, so your system must have the
following libraries installed:

- gtk3
- python3 >= 3.11
- python3-gobject
- python3-pyxdg

* Installation

The source of this application can be retrieved from the following websites:

- [[https://laboratory.kawateam.dev/Geode/gem][Kawa-Team Git forge (main repository)]]
- [[https://framagit.org/geode/gem][Framagit Git forge (mirror repository)]]
- [[https://archives.kawateam.dev/geode-gem/][Kawa-Team archives repository]]

This application can be installed through multiple packages manager.

** Installing on Arch Linux / Parabola

Geode-Gem is available on the Kawa-Team Arch Linux packages repository and from
the AUR.

- [[https://packages.kawateam.dev/][Kawa-Team packages repository]]
- [[https://aur.archlinux.org/packages/geode-gem][Arch Linux User Repository (AUR)]]

** Installing with Guix

This application can be installed with the [[https://guix.gnu.org/][GNU Guix]] package manager on your
favorite system.

The following command will install Geode-Gem on your profile:

#+begin_src shell
  guix package -f guix.scm
#+end_src

Its also possible to start Geode-Gem in a dedicated development environment
with all the correct dependencies:

#+begin_src shell
  guix shell -D -m manifest.scm -- python3 -m geode_gem
#+end_src

** Installing with Pip

It can be installed from a Python packages manager like =pip= in a dedicated
virtual environment.

#+begin_src shell
  python3 -m venv env
  source env/bin/activate
  pip install git+https://laboratory.kawateam.dev/Geode/gem
  geode-gem
#+end_src

* Usage

Use the =geode-gem= command to start the application.

** Profile

The profile will contains all the collections and launchers configurations, the
database with the games information and the game files (logs and notes).

Its possible to change the default profile by using the =--profile= argument.

The profile set with this argument can be removed from the file system by
using, the =--delete-profile= argument.

The profile can also be renamed with the =--rename-profile= argument.

The list of profiles stored in Geode-Gem can be retrieved by using the
=--list-profiles= argument.

** Directories

This application use the [[https://specifications.freedesktop.org/basedir/][XDG Base Directory]] specification:

- Configurations are stored under =$XDG_CONFIG_HOME/geode-gem/<profile>/=
- Data files are stored under =$XDG_DATA_HOME/geode-gem/<profile>/=
- Cache of icons is stored under =$XDG_CACHE_HOME/geode-gem/<profile>/=
- Lock file is stored under =$XDG_RUNTIME_DIR/geode-gem/<profile>/lock=
- Main log file is stored under =$XDG_STATE_HOME/geode-gem/<profile>/geode-gem.log=

** Logging level

During execution, the main application will log information in the file named
=geode-gem.log=.

Its possible to define the minimal level of logging with the =--log-level=
argument. By default, =warning= will be used as the minimal level.

* Managed Launchers

The configuration files for these launchers are available in this application:

- [[https://atari800.github.io/][Atari800]] (Atari 8-bit / 5200)
- [[https://desmume.org/][DeSmuME]] (Nintendo DS)
- [[https://dolphin-emu.org/][Dolphin]] (Nintendo Game Cube / Wii)
- [[https://dosbox-staging.github.io/][DOSBox]] (Disk Operating System)
- [[https://fceux.com/web/home.html][Fceux]] (Nintendo NES)
- [[https://github.com/0ldsk00l/nestopia][Nestopia]] (Nintendo NES)
- [[https://hatari.tuxfamily.org/][Hatari]] (Atari ST)
- [[https://mednafen.github.io/][Mednafen]] (Multiple systems)
- [[https://mgba.io][mGBA]] (Nintendo Game Boy Advance)
- [[https://mupen64plus.org/][Mupen64plus]] (Nintendo 64)
- [[https://pcsx2.net/][PCSX2]] (Sony PlayStation 2)
- [[https://specifications.freedesktop.org/desktop-entry/latest/][Native]] (GNU/Linux)
- [[https://stella-emu.github.io/][Stella]] (Atari 2600)
- [[https://www.ppsspp.org/][PPSSPP]] (Sony PlayStation Portable)
- [[https://www.scummvm.org/][ScummVM]] (Virtual machine for the SCUMM system)
- [[https://www.winehq.org][Wine]] (Microsoft Windows compatibility layer)

For more information on the licenses used by these launchers, you can check the
file [[file:docs/EMULATORS][EMULATORS]] under the docs directory.

* Contact

If you encounter a bug during the usage of Geode-Gem, you can write an email
to [[mailto:geode-gem@kawateam.dev]]. The list of current issues can be consulting
on https://laboratory.kawateam.dev/geode/gem/issues.

You can also join the following discussion channels, hosted by the [[https://kawateam.dev/][Kawa-Team]]
organisation:

- The [[irc:irc.kawateam.org#geode-gem][#geode-gem]] IRC channel
- The [[xmpp:geode-gem@conference.kawateam.org][geode-gem]] XMPP conference

* Copyright information

Geode-Gem is a free software redistributed under the [[https://www.gnu.org/licenses/gpl-3.0.html][GNU General Public]] version
3 or later license.

The information about the authors of this program are available in the [[file:AUTHORS][AUTHORS]]
file.

The logo of Geode-Gem was made by PacMiam with the [[https://www.gimp.org/][GIMP]] software and released
under the [[https://artlibre.org/][Free Art]] license.

The consoles icons used by this application come from the [[https://commons.wikimedia.org/wiki/User:Evan-Amos][Evan-Amos]] gallery and
are public domain.
