/gemboy

Nintendo Gameboy emulator in Ruby (obviously incomplete)

Primary LanguageRubyMIT LicenseMIT

Gemboy

Implements a Nintendo Gameboy emulator in Ruby. Very much WIP. Starting with parsing cart dumps and moving to a CPU emulator and debugger.

I've always wanted to write an emulator and I figured another "simple" somewhere in the same ballpark as optcarrt would be interesting to measure under Ruby's new incoming JIT.

This project does not redistribute ROMs.

Installation

Add this line to your application's Gemfile:

gem 'gemboy'

And then execute:

$ bundle

Or install it yourself as:

$ gem install gemboy

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gemboy.

License

The gem is available as open source under the terms of the MIT License.