aowalke2 / iron-boy

A Game Boy Emulator written in Rust

Iron Boy

A GameBoy emulator, written in Rust.

In my quest to build a GBA emulator in Rust, I made a Game Boy emulator in Rust.

To Do

• MBC2, MBC3, MB5 cartridge support
• CGB support
• WASM for browser support
• Refactor CPU to use into adn from traits
• Give components a common trait
• GDB?
• Sound issues

Getting Started

Make sure you have the latest version of Rust installed

Mac OS with homebrew

brew install sdl2

Ubuntu

sudo apt update && sudo apt install -y libsdl2

Running

cargo run <rom file path>

• You can also build a release and run the executable as well

Keymappings

Joypad	Keyboard
A	X
B	Z
Start	Space
Select	Enter
Up	Up Arrow
Down	Down Arrow
Left	Left Arrow
Right	Right Arrow

Tests

Blargg's tests

Test	Status
cpu instrs	👍
instr timing	👍

* Other Blargg tests failing or can not test due to not supporting CGB at the moment

DMG Acid test

Test	Status
DMG Acid	👍

Acknowledgements and Sources

• Pan Docs
• Game Boy Opcodes
• gbz80(7) — CPU opcode reference
• Ultimate Game Boy Talk
• A journey into GameBoy emulation
• GBEDG
• GhostSonic Reddit Post on Sound
• Game Boy Sound Emulation

Awesome Emulators

These are some awesome emulators by some really smart people that helped me get to this point.

• LLG_gbemu
• gb-rs
• rboy
• gaemboi