CryBoy

A Game Boy (Color) emulator written in Crystal

CryBoy is a Game Boy (Color) emulator written in Crystal. The goal of this project is to create an efficient Game Boy emulator with highly readable code.

This would not be possible without the Pan Docs, izik's opcode table, or the gzb80 opcode reference. A thanks also goes out to PyBoy, which was a useful reference when I first started this project.

Installation

SDL2 is a requirement for this project. Install that in whichever way you see fit.

After cloning the respository, you can install the required shards with shards install. If you don't do this directly, they'll be installed when you build the project.

Usage

After installing the dependencies, the project can be built with shards build --release. At this point, the binary lives in bin/cryboy. The binary takes a an optional CGB bios path and a rom path as its arguments: bin/cryboy /path/to/rom or bin/cryboy /path/to/bios /path/to/rom.

Note: The Game Boy Color bios initializes the color palettes in some old Game Boy games to give them an updated look. This is why Pokemon Blue (which was developed for the original Game Boy and only had 4 colors) has a handful more colors, including a blue primary color and a red color for the character sprites. If you choose to launch a game for the original Game Boy without the Game Boy Color bios, you'll only see the games in 4 colors as you would on an original Game Boy. Games with native support for the Game Boy Color, like Pokemon Silver, should behave the same with or without the bios.

Keybindings

The current keybindings are very tuned to my own personal preferences. If the following layout diagram doesn't work for you, the "a" and "b" keys are also bound to their appropriate keys, as are the arrow keys.

Features and Remaining Work

CryBoy is still a work in progress. As of right now, all of the following features are supported

There is still a lot missing from CryBoy. Some of these missing pieces include

  • Picture processing
    • Pixel FIFO
      • Pixel FIFO will likely only be relevant in 0.01% of games, so it's not a priority. It's a nice-to-have at some point down the road
  • Misc
    • Failing the mooneye-gb rapid_toggle timer test by 4 T-cycles. Needs to be debugged
    • Failing the mooneye-gb ie_push test, which tests specific timing of interrupts and what happens if the IE register is pushed to during the interrupt handling.
    • Slight graphical glitch in Pokemon Crystal when opening menus, but entirely playable.
    • Major graphical glitches in Tomb Raider sprites.

Contributing

  1. Fork it (https://github.com/mattrberry/CryBoy/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

Owner
github statistic
  • 52
  • 0
  • 3
  • 0
  • about 12 hours ago
  • May 13, 2020
License

MIT License

Links
Synced at

Thu, 13 Aug 2020 07:05:47 GMT