Gameboy R

A Gameboy emulator written in Rust. This emulator supports both Gameboy and Gameboy Color. A checklist of implemented features can be found below.

How to Use:

You can run the emulator using the following command and specifying the path to your rom: $ cargo run --release -- "./path/to/rom.gb" The following options can be specified -s, --save Path to .sav file of the specified ROM (Default: location of ROM) -x, --scale Scale the window by a factor of 1, 2, 4 (Default: 1) --skip-checks Skip header checksum and nintendo logo checks for ROM

With Crates.io

You can install the emulator from Crates.io using: $ cargo install gameboyr Then run the emulator using: $ gameboyr "./path/to/rom.gb" The options specified above are also available here.

Controls:

__________________________ | | | .----------------------. | | | .----------------. | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | '----------------' | | | |______________________/ | | | | . GAMEBOY R | Up | _| |_ .-. | ---> Z Left + Right <--- |-[_ _]- .-. ( ) | Down | |_| ( ) '-' | ---> X | ' '-' A | | B | | ___ ___ | | (___) (___) ,., | ---> Enter / Select | select start ;:;: | | ,;:;' / | ,:;:'.' '-----------------------`

Implemented:

• [x] CPU
  • [x] Registers & Flags
  • [x] Instruction Set
  • [x] Timing
• [X] MMU
  • [x] Work RAM (WRAM)
  • [x] High Ram (HRAM)
  • [x] HDMA & GDMA
  • [x] Speed switch
• [X] I/O
  • [X] Video Display (PPU)
  • [ ] Sound Controller (APU)
  • [x] Joypad Input
  • [x] Serial Data Transfer
  • [x] Timer
• [x] Cartridges
  • [x] None (32KByte ROM only)
  • [x] MBC1 (max 2MByte ROM and/or 32KByte RAM)
  • [x] MBC2 (max 256KByte ROM and 512x4 bits RAM)
  • [x] MBC3 (max 2MByte ROM and/or 64KByte RAM and Timer)
  • [x] MBC5 (max 8MByte ROM and/or 128KByte RAM)

References:

• Pandocs
• GBDev Pandocs
• GBDev Wiki
• GBOps
• Pastraiser (OP Codes)
• Cartridge Header
• Cartridge Types
• GB ROMS
• GBC ROMS