+
Skip to content

vgambier/gintonic

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

71 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gintonic

gintonic is a lightweight emulation front-end that works in a terminal. It is designed to be fast, to be comfortable for keyboard users, and to work through ssh. This allows you to have a unified text-based interface for browsing and launching all of your games using any emulator. You can use any emulator you want as long as you specify the command in the configuration file yourself.

Features

  • Support of vim-style keys
  • Instant search
  • Script based confguration

Requirements

  • Python 3. Tested with Python 3.10.12
  • Only tested on Linux

Installation

  • Clone this repository
  • Place a config file named config.json into ~/.config/gintonic. You can copy the example found in config_template/ for this purpose. That file has working commands for many popular emulators - feel free to tweak the commands, flags, and system/folder names.

Configuration

Example:

{
  "paths_to_games": [
    "/home/user/foobar/games1",
    "/home/user/foobar/games2"
  ],
  "systems": {
    "Sony - Amiga DS": "aMIG0S {0} --fullscreen",
    "Arcade": "mame {0}",
    "Sega - Dreamcast": "./flycast.sh {0}"
  }
}

paths_to_games - each path in this list is a path to a directory with games that should have the following structure:

├── System1
│   ├── Game1
│   ├── Game2
│   └── Game3
└── System2
    └── Game1

Where: SystemX - is the name of a system/folder (DOS, NES, etc).
GameX - is the name of a game. Can be file or a folder, depending on the system.

systems - allows you to specify a command to run a game on a particular system. {0} (or {}) is substituted by the absolute path of the game you are launching.

Arcade is a special case. The entry also specifies which command will be used to launch arcade games with MAME, but you do not need a game folder called Arcade. gintonic uses MAME's internal database to list available games - this assumes you don't have missing MAME roms. Note: this only works with MAME.

Running gintonic

  • ./gintonic.py

To exit, press `q`.

Controls

  • q: quit current menu
  • l: open system, launch game
  • ENTER: open system, launch game, confirm search
  • /: enter search feature
  • ESC: cancel search
  • k / : scroll up
  • j / : scroll down
  • [mouse wheel]: scroll up and down
  • CTRL+c: exit gintonic

Desktop entry

.desktop and .svg files are provided. To add gintonic as a desktop entry, edit gintonic.desktop to reflect the directory in which gintonic.py is located then run the following commands:

  • cp gintonic.desktop ~/.local/share/applications/
  • cp gintonic.svg ~/.icons/

This uses gnome-terminal as the terminal emulator. If you want to use a different terminal emulator, you have two options:

  • edit the Exec line to explicitly state your terminal emulator of choice (e.g.: kgx ./gintonic.py)
  • edit the Exec line to remove gnome-console (Exec=./gintonic.py) and add the following line: Terminal=true)

About

A lightweight game launcher that works in a terminal.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 95.2%
  • Shell 4.8%
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载