gambaterm

A terminal frontend for gambatte game boy color emulator

These details have not been verified by PyPI

Project links

Homepage

Project description

gambatte-terminal

A terminal front-end for gambatte, the gameboy color emulator.

It supports:

16 colors, 256 colors and 24-bit colors terminal
Playing audio from the emulator
Using TAS input files as game input
Using keyboard presses as game input

Installation

Wheels are available on linux, windows and macos for python 3.6, 3.7, 3.8 and 3.9:

$ pip3 install gambaterm

Usage and arguments

Usage:

usage: gambaterm [-h] [--input-file INPUT_FILE] [--frame-advance FRAME_ADVANCE] [--break-after BREAK_AFTER] [--speed-factor SPEED_FACTOR] [--force-gameboy]
                 [--skip-inputs SKIP_INPUTS] [--cpr-sync] [--disable-audio] [--color-mode COLOR_MODE]
                 ROM

Positional arguments:

ROM

Path to a GB or GBC rom file

Optional arguments:

--input-file INPUT_FILE, -i INPUT_FILE

Path to a bizhawk BK2 input file
--frame-advance FRAME_ADVANCE, --fa FRAME_ADVANCE

Number of frames to run before displaying the next one (default is 1)
--break-after BREAK_AFTER, --ba BREAK_AFTER

Number of frames to run before forcing the emulator to stop (doesn't stop by default)
--speed-factor SPEED_FACTOR, --sf SPEED_FACTOR

Speed factor to apply to the emulation (default is 1.0 corresponding to 60 FPS)
--force-gameboy, --fg

Force the emulator to treat the rom as a GB file
--skip-inputs SKIP_INPUTS, --si SKIP_INPUTS

Number of frame inputs to skip in order to compensate for the lack of BIOS (default is 188)
--cpr-sync, --cs

Use CPR synchronization to prevent video buffering
--enable-controller, --ec

Enable game controller support
--disable-audio, --da

Disable audio entirely
--color-mode COLOR_MODE, -c COLOR_MODE

Force a color mode (1: 4 greyscale colors, 2: 16 colors, 3: 256 colors, 4: 24-bit colors)

SSH server

It is possible to serve the emulation though SSH, although clients won't be able to send input to the emulator without an X server and the ssh -X option. Use gambaterm-ssh --help for more information.

Terminal support

Not all terminals will actually offer a pleasant experience. The main criteria are:

Support for basic ANSI codes (VT100) More specifically setting background/foreground colors and moving cursor (absolute and relative). Those are usually supported.
Support for at least 256 colors Those are usually supported. 16 colors also works but it doesn't look too good. In this case, it might be better to use greyscale colors using --force-gameboy or --color-mode=1.
Support for UTF-8 and good rendering of unicode block elements More specifically the following characters ▄ █ ▀. Changing the code page might be necessary on windows, using chcp 65001. Also, the alignement might be off (e.g small spaces between pixels) This is not always well supported.
Good rendering performance The terminal has to be able to process about 500KB of requests per seconds for a smooth rendering of "intense" frames. Typically, the most intense frames happen during screen transitions of two detailed scenes.

The table below sums up my findings when I tried a the most common terminal emulators. Here's about linux:

Linux	Status	Colors	Unicode rendering	Performance	Comments
Gnome terminal	Excellent	24-bit colors	Good	60 FPS
Terminator	Excellent	24-bit colors	Good	60 FPS
Kitty	Excellent	24-bit colors	Good	60 FPS
XTerm	Good	24-bit colors	Good	60 FPS	No resize shortcuts
Termit	Ok	24-bit colors	Good	60 FPS	No window title
Rxvt	Ok	256 colors	Good	60 FPS	No resize shortcuts
Mlterm	Ok	24-bit colors	Light misalignments	60 FPS	No resize shortcuts
Terminology	Ok	24-bit colors	Possible misalignments	30 FPS	Weird colors

About MacOS:

MacOS	Status	Colors	Unicode rendering	Performance	Comments
iTerm2	Good	24-bit colors	Good	30 FPS
Terminal	Unplayable	256 colors	Misalignments	20 FPS

About Windows:

Windows	Status	Colors	Unicode rendering	Performance	Comments
Windows terminal	Unpleasant	24-bit colors	Good (`chcp 65001`)	30 FPS	Buggy display
Cmder	Unplayable	24-bit colors	Good (`chcp 65001`)	2 FPS	No window title
Terminus	Unplayable	24-bit colors	Misalignments	10 FPS
Command prompt	Broken	N/A	N/A	N/A	No ANSI code support
Git bash	Broken	N/A	N/A	N/A	Doesn't work with winpty

Terminal size

The emulator uses a single character on screen to display two vertically aligned pixels, like so ▄▀. The gameboy being 160 pixels wide over 144 pixels high, you'll need your terminal to be at least 160 characters wide over 72 characters high to display the entire screen. Setting the terminal to full screen is usually enough but you might want to tweak the character size, typically using the ctrl - / ctrl + or ctrl wheel shortcuts.

Keyboard, game controller and file inputs

Keyboard controls are enabled by default, while game controller controls have to be enabled using --enable-controller or --ec. The key bindings are not configurable at the moment:

Buttons	Keyboard	Controller
Directions	Arrows	Left hat / Left stick
A	F / V / Space	Button 0 / Button 3
B	D / C / Alt	Button 1 / Button 2
Start	Right Ctrl / Enter	Button 7
Select	Right Shift / Delete	Button 6

Key releases, which are usually mandatory to play games, cannot be detected through stdin. It is then required to access the window system to get access to the key presses. There are a couple of problems with that:

It can be hard to detect the window corresponding to the terminal. With X11, the best solution is to look for the current focused window. For other systems, the fallback solution is to use global hotkeys.
It only works through SSH for clients with X servers using ssh -X, meaning it requires Windows and MacOS users to run an X server. Moreover, it's a bad idea to connect with -X to an untrusted server.
Additional permissions might be required to access the window system, especially on MacOS (see this guide)

It is also possible to use a bizhawk BK2 input file to play tool-assisted speedruns using the --input-file (or -i) option.

Motivation

To be honest there is no actual reason to use this gameboy emulator, other than you might find it fun or interesting. The motivation behind this project is simply to push the idea of running a video game console emulator in a terminal as far as possible. It seems like there has been a similar attempt that used a different approach for displaying the video stream. In any case I'm quite satisfied with this project, and also a bit surprised that I could push it to the point where playing games is actually enjoyable. In particular, I've been able to complete The Bouncing Ball at 60 FPS in XTerm, and I'm now looking forward to playing more homebrew games :)

Dependencies

Here is the list of the dependencies used in this project, all great open source libraries:

gambatte - Gameboy emulation
Cython - Binding to gambatte C++ API, and fast video frame conversion
prompt-toolkit - Cross-platform terminal handling
samplerate - Resampling the audio stream
sounddevice - Playing the audio stream
xlib/pynput - Getting keyboard inputs
pygame - Getting game controller inputs
asyncssh - Running the SSH server

Contact

Vincent Michel

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

0.12.7

Jul 2, 2024

0.12.4

Nov 14, 2023

0.12.3 yanked

Nov 14, 2023

0.12.2

Jul 17, 2023

0.12.1

Sep 25, 2022

0.12.0

Sep 25, 2022

0.11.0

Sep 20, 2022

0.10.0

Aug 22, 2022

0.9.9

Aug 21, 2022

0.9.8

Aug 21, 2022

0.9.7

Sep 30, 2021

This version

0.9.6

Jun 27, 2021

0.9.5

Mar 17, 2021

0.9.4

Mar 16, 2021

0.9.3

Mar 13, 2021

0.9.2

Mar 12, 2021

0.9.1

Feb 25, 2021

0.9.0

Feb 11, 2021

0.8.1

Feb 10, 2021

0.8.0

Feb 8, 2021

0.7.0

Feb 3, 2021

0.6.2

Jan 28, 2021

0.6.1

Jan 27, 2021

0.5.0

Jan 25, 2021

0.4.1

Jan 21, 2021

0.4.0

Jan 21, 2021

0.3.0

Jan 20, 2021

0.2.0

Jan 19, 2021

0.1.2

Jan 19, 2021

0.1.0

Jan 19, 2021

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gambaterm-0.9.6.tar.gz (136.8 kB view details)

Uploaded Jun 27, 2021 Source

Built Distributions

gambaterm-0.9.6-cp39-cp39-win_amd64.whl (180.1 kB view details)

Uploaded Jun 27, 2021 CPython 3.9 Windows x86-64

gambaterm-0.9.6-cp39-cp39-manylinux2010_x86_64.whl (1.4 MB view details)

Uploaded Jun 27, 2021 CPython 3.9 manylinux: glibc 2.12+ x86-64

gambaterm-0.9.6-cp39-cp39-manylinux1_x86_64.whl (1.4 MB view details)

Uploaded Jun 27, 2021 CPython 3.9

gambaterm-0.9.6-cp39-cp39-macosx_10_9_x86_64.whl (210.8 kB view details)

Uploaded Jun 27, 2021 CPython 3.9 macOS 10.9+ x86-64

gambaterm-0.9.6-cp38-cp38-win_amd64.whl (181.8 kB view details)

Uploaded Jun 27, 2021 CPython 3.8 Windows x86-64

gambaterm-0.9.6-cp38-cp38-manylinux2010_x86_64.whl (1.4 MB view details)

Uploaded Jun 27, 2021 CPython 3.8 manylinux: glibc 2.12+ x86-64

gambaterm-0.9.6-cp38-cp38-manylinux1_x86_64.whl (1.4 MB view details)

Uploaded Jun 27, 2021 CPython 3.8

gambaterm-0.9.6-cp38-cp38-macosx_10_9_x86_64.whl (212.8 kB view details)

Uploaded Jun 27, 2021 CPython 3.8 macOS 10.9+ x86-64

gambaterm-0.9.6-cp37-cp37m-win_amd64.whl (181.1 kB view details)

Uploaded Jun 27, 2021 CPython 3.7m Windows x86-64

gambaterm-0.9.6-cp37-cp37m-manylinux2010_x86_64.whl (1.4 MB view details)

Uploaded Jun 27, 2021 CPython 3.7m manylinux: glibc 2.12+ x86-64

gambaterm-0.9.6-cp37-cp37m-manylinux1_x86_64.whl (1.4 MB view details)

Uploaded Jun 27, 2021 CPython 3.7m

gambaterm-0.9.6-cp37-cp37m-macosx_10_9_x86_64.whl (212.5 kB view details)

Uploaded Jun 27, 2021 CPython 3.7m macOS 10.9+ x86-64

gambaterm-0.9.6-cp36-cp36m-win_amd64.whl (181.1 kB view details)

Uploaded Jun 27, 2021 CPython 3.6m Windows x86-64

gambaterm-0.9.6-cp36-cp36m-manylinux2010_x86_64.whl (1.4 MB view details)

Uploaded Jun 27, 2021 CPython 3.6m manylinux: glibc 2.12+ x86-64

gambaterm-0.9.6-cp36-cp36m-manylinux1_x86_64.whl (1.4 MB view details)

Uploaded Jun 27, 2021 CPython 3.6m

gambaterm-0.9.6-cp36-cp36m-macosx_10_9_x86_64.whl (212.5 kB view details)

Uploaded Jun 27, 2021 CPython 3.6m macOS 10.9+ x86-64

File details

Details for the file gambaterm-0.9.6.tar.gz.

File metadata

Download URL: gambaterm-0.9.6.tar.gz
Upload date: Jun 27, 2021
Size: 136.8 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for gambaterm-0.9.6.tar.gz
Algorithm	Hash digest
SHA256	`b5af5525531773da6399ab2cbdb06b988902a4313382a98dae86d6c1c3fd6987`
MD5	`471882394fd96121c5b191a99e2643ea`
BLAKE2b-256	`5d326e6b854ffcbde5173e7c56bc62192d0032cc6eebe4e0244c1de8b2eb3b2a`

Algorithm	Hash digest
SHA256	`dea3a687ead80f6affc18e73dbe928b659de24587603b7a457fd2725ddf7ee68`
MD5	`138623736fa199eed39b0ea824b4114c`
BLAKE2b-256	`5e1f77bd25b1d3445ecc5405c047e8f346ecbaba4811827d03f78214e1d004d7`

Algorithm	Hash digest
SHA256	`63f0b9a35678a54388488bdc013e5f0d04a9117db963eb139ea456b4e7cf155b`
MD5	`a2fe01b481844812b350462bddc644dc`
BLAKE2b-256	`4398b86869cb0b4ed21ea471c5b4f1d898f2109b7d48cd87382eb2433ccf23d0`

Algorithm	Hash digest
SHA256	`b9ec11881dee489f37f152bc0ca7b17b31e034b766da45b76f9848a683965b61`
MD5	`db0b872e5106211b42bf2544b61dfeb8`
BLAKE2b-256	`018a1ff1fcb6e66488e6f56a6294974d52cb32802043808515da164936a97ce4`

Algorithm	Hash digest
SHA256	`d570da2096c1badca7f21bea91e07777bd9350aafd11eb38f49432c8c4163946`
MD5	`f25fbeb149c5af05b7820966ccaf5eb6`
BLAKE2b-256	`53dfb91563c2f528034f5af18965ff226329dcce1ed690ad9faa8b345a76e0fe`

Algorithm	Hash digest
SHA256	`c742d2980259776c6d06535ca1eb9eb34f5c9eb005bc7a6666a6b4a105a98d6f`
MD5	`af8da5560f3f2cc87a2dc77977c4f98c`
BLAKE2b-256	`c8f374084dee3f5e11b4e0c5386c4097b128ca22f0ed54f44dad94b3dc6dd7e5`

Algorithm	Hash digest
SHA256	`67e1040b956d81c357d44d78387f1cb5c9d3b50155ecc32561882b99216f2474`
MD5	`921014532cdfae24b2ae2f5ed8330894`
BLAKE2b-256	`8fbf944ba6ecf77816e77aea4f487bdc843b45017273e0940524b13464a3b5ec`

Algorithm	Hash digest
SHA256	`2185ab05d499d9766134e8fe6af43483d3a46a4c84acb0b09bd5cf20a1a11a56`
MD5	`682147f5f82c3ffb0bfebeca5dbd486f`
BLAKE2b-256	`104bf907a22f5e141001b6fc4f28a5a258153ac3eba75755e50932febadc804b`

Algorithm	Hash digest
SHA256	`1186b7060622ba6ec2279956c80c1c4aa80fcd8c0f6513de619e90e075ce0bc3`
MD5	`e4140f94ab3ee5a1af1d62a7c6348960`
BLAKE2b-256	`4c81504b8a3e6c3974daf82a2179f81ad68096df93580a70705b3b3e598a50a8`

Algorithm	Hash digest
SHA256	`5655ef7be6a0f04922fa8b13ea2f0bc34ff4619c149cc065287ec15075385f4a`
MD5	`461b52c8d4185e43ea69a65d17262817`
BLAKE2b-256	`2c0f263eb2190887d4cc14ad8eb04476671fb62cf4eb3e8c6779533f98111ce2`

Algorithm	Hash digest
SHA256	`f7719dd9d75d528d9fd36e20c98ee6794ba7637bdbea824f083cdda4a8dfcfc3`
MD5	`0bd2fe0285bde22f402c0763842a9b98`
BLAKE2b-256	`3df8b65a58d5688e633703bf77d6a62a3d5d1ff72f02214cf9b895f1fba97a2b`

Algorithm	Hash digest
SHA256	`cc97f87cbb12a3937d7313d62ecffe5042af3508ecd3daaff6ec5c14de6306ed`
MD5	`5eb9cd76d88fed53bbb0ad4949b66e65`
BLAKE2b-256	`05367f9300d4397f83766fa1f21980b0b132257140688435ed0d1cdcef6504d5`

Algorithm	Hash digest
SHA256	`e1b1dd6387b2d1dac866fc57319d834ba47a431dd3fb8c668827800b7905dee9`
MD5	`5d1a94d6a7b559130ec4ef2eba2622b5`
BLAKE2b-256	`71e4a090c89fa8257a2f8110a0e07dbb3193458c1be9f185a9a6bf6d76e6696b`

Algorithm	Hash digest
SHA256	`f32e849b412a147def807d5301178a6398b0a6542f03aaa4c4830f66729a3819`
MD5	`ac9706db7e0e1f2934f55ef49e0a4fa3`
BLAKE2b-256	`5e3e1dd4f579ff1357ac5aa1569690181841960020ff7992873b5fe3c230d06e`

Algorithm	Hash digest
SHA256	`e182a20b9d62524d28274aebf7e7177f5b95543f157cd4e6d756454f2f0a6f5f`
MD5	`f835cd182836663e398168a3995591ae`
BLAKE2b-256	`139a29a9675e4490712df4f7f6c1d7168db9a4fd6caf53e85494b12343c287d5`

Algorithm	Hash digest
SHA256	`556731f8161897114a093856e4e844824ef799ad1f9a442bc186f829ed8bea07`
MD5	`78c29c0eda061a467f307e7fb5e683bd`
BLAKE2b-256	`63d295743c95f9bd8dfdd616b21e4f44d980b6ca55fc4b0225f8c61b48aaf244`

Algorithm	Hash digest
SHA256	`288dc50409643de0c4a3ea14392d4c4e38c3fe25897919a5d1e9dcb89fc51005`
MD5	`57cdffce804a3223b6140d2f41f4e259`
BLAKE2b-256	`f53fb724e3e895144f1865034d2e2a2c4606f52b4ad6f1b7a0e65bb36712966a`

gambaterm 0.9.6

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

gambatte-terminal

Installation

Usage and arguments

SSH server

Terminal support

Terminal size

Keyboard, game controller and file inputs

Motivation

Dependencies

Contact

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distributions

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata