The slowest Game Boy emulator.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Zack Marvel e388031796 Fix button bug 1 月之前
notes Thoughts on implementing a debugger 2 年之前
scripts Pretty functional debugger, still trying to figure out wh 1 月之前
slowboy Fix button bug 1 月之前
test_roms Pretty functional debugger, still trying to figure out wh 1 月之前
tests Pretty functional debugger, still trying to figure out wh 1 月之前
.gitignore Ignore a bunch of junk in my working directory 1 年之前
.travis.yml change directory back to project root after building SDL2 2 年之前
LICENSE Initial commit 5 年之前
README.md Pretty functional debugger, still trying to figure out wh 1 月之前
coverage coverage helper script 1 年之前
ctags ctags helper script 1 年之前
regs.txt Actually playing with an implementation of a CPU. Also added some notes. 4 年之前
setup.py Move Pillow to development deps; add pytest to development deps 2 年之前

README.md

slowboy

slowboy aims to be the slowest Gameboy emulator. Just kidding---but the goal of this project isn’t to create a fast emulator, since those already exist. The goal is twofold: can a reasonably performant Gameboy emulator be build in Python, and can it serve as an easy-to-read codebase for others who want to emulate this system?

TODO

  • Audio
  • Handle different bank controller configurations

See notes/performance.md for some thoughts on speeding up the emulator.

An eventual goal is improving the debugger---see notes/debugging.md.

Test ROMs

  • Test interrupts

Installation

If you install this emulator, it probably won’t play very many games. Here are some things you could do:

  • Try running games and create an issue if they don’t run, especially if it crashes.
  • Try running or writing the test “games” in test_roms/ and create an issue if they don’t work or crash on your system.

If hacking on it is what you’re interested in, please forge ahead!

Development

Dependencies

This program uses SDL2 for graphics, and eventually the unit tests will require some of the SDL2 data structures. Currently, it requires at least libsdl2 version 2.0.5 or greater. I’d like to eventually relax the requirement to at most 2.0.2 to support Debian 8 and Ubuntu 16.04.

On the following distributions, the SDL2 package is too old, so you’ll need to build it from source:

  • Debian 8 (2.0.2)
  • Ubuntu 14.04 (2.0.2) and 16.04 (2.0.4)

I develop on Linux---these Linux distributions package at least libsdl2 version 2.0.5:

  • Debian 9: libsdl2-2.0-0 (2.0.5)
  • Ubuntu 18.04: libsdl2-2.0-0 (2.0.8)
  • CentOS 7: SDL2 (2.0.8, from EPEL---install epel-release)

Installation

After cloning the repository, you can install the project for development with

$ pip install --editable .\[dev\]

You can run the tests from the root of the project with

$ pytest

Additionally, if you have coverage installed, you can use that:

$ coverage run --source slowboy -m unittest discover tests
$ coverage html

Known Issues

Running the unit tests with pytest on my system causes a segfault for some reason. The workaround is just running the tests with unittest:

$ python -m unittest discover tests