Home

Awesome

gbemu

gbemu is a Nintendo Gameboy emulator written in C++. It was written as an exercise (and for fun!) so its goals are exploration of modern C++ and clean code rather than total accuracy.

Building

Building the emulator requires cmake and SDL and has been tested on macOS and Debian. To compile the project, run:

$ make

This builds two versions of the emulator:

Playing

usage: gbemu <rom_file> [--debug] [--trace] [--silent] [--exit-on-infinite-jr] [--print-serial-output]

arguments:
  --debug                   Enable the debugger
  --exit-on-infinite-jr     Stop emulation if an infinite JR loop is detected
  --print-serial-output     Print data sent to the serial port
  --trace                   Enable trace logging
  --silent                  Disable logging

The key bindings are: <kbd></kbd>, <kbd></kbd>, <kbd></kbd>, <kbd></kbd>, <kbd>X</kbd>, <kbd>Z</kbd>, <kbd>Enter</kbd>, <kbd>Backspace</kbd>.

Tests

The emulator is tested using Blargg's tests - these can be ran with ./scripts/run_test_roms.

<img src="./.github/images/blarggs-tests-pass.png" width="400">

Missing features

Currently, gbemu only supports Gameboy games. I'm working on Gameboy Color support off-and-on at the moment. There's also no audio support yet.

Screenshots

MenuGameplay
<img src="./.github/images/tetris-menu.png" width="400"><img src="./.github/images/tetris-gameplay.png" width="400">
<img src="./.github/images/zelda-menu.png" width="400"><img src="./.github/images/zelda-gameplay.png" width="400">
<img src="./.github/images/pokemon-menu.png" width="400"><img src="./.github/images/pokemon-gameplay.png" width="400">