Find a file
2016-09-01 21:04:46 +10:00
bin init commit 2016-05-08 17:20:05 +10:00
documentation added keymap image 2016-09-01 21:04:46 +10:00
exe init commit 2016-05-08 17:20:05 +10:00
lib set new default window width 2016-09-01 19:51:03 +10:00
spec add ppu spec, moved vblank into method and accessor mode + modeclock 2016-07-31 13:24:00 +10:00
.gitignore init commit 2016-05-08 17:20:05 +10:00
.rspec init commit 2016-05-08 17:20:05 +10:00
.ruby-version init commit 2016-05-08 17:20:05 +10:00
.travis.yml init commit 2016-05-08 17:20:05 +10:00
CODE_OF_CONDUCT.md init commit 2016-05-08 17:20:05 +10:00
Gemfile init commit 2016-05-08 17:20:05 +10:00
Guardfile init commit 2016-05-08 17:20:05 +10:00
Rakefile init commit 2016-05-08 17:20:05 +10:00
README.md updated README to reflect changes to working emulator & fixed typo 2016-08-14 23:19:22 +10:00
waterfoul.gemspec disable input, improve screen implementation 2016-08-14 15:06:17 +10:00

Waterfoul

Waterfoul is a Gameboy emulator written in Ruby-lang. It is just a casual excersize by myself to learn the internals of the device and how it works.

Requirements

The sdl2 library is currenty used to render pixels. Most platforms have packages avaliable, else see here. This library is required and needs to be installed before you can run the emulator.

Can it play roms?

Yes! but the list of roms that i know work is very limited to just Tetris, Super Mario Land and Pokemon Red. But a lot of work is being put into making other games compatable. The device does run the internal boot program succesfully and is passing test programs sucesfully (barggs).

Testing

If you wish to run the test suite, download the source code (make sure to run bundle install) and run bundle exec rspec

How do i run the emulator?

If you wish to see the emulator in action, download a rom online which typically have a .gb extension and place it onto your local file system. To start the emulator:

bundle exec exe/waterfoul start <path to rom>

Make sure to bundle install first.

The boot program will be executed by default, if you wish to skip it add --skip-boot as an option.