GameBoy DMG emulator

Usage

Usage: lameboy [OPTIONS] <CARTRIDGE>

Arguments:
  <CARTRIDGE>  Cartridge

Options:
  -b, --breakpoint <BREAKPOINT>  Breakpoints
  -s, --step-by-step             Step by step
  -n, --nofps                    Skip FPS limiter
      --opcode-dump              Dump opcode list to file
      --tiles                    Tile map debug window
      --background               Background map debug window
      --window                   Window map debug window
      --skip-intro               Skip intro logo scrolling phase
      --disable-sound            Turn all sounds off
  -h, --help                     Print help
  -V, --version                  Print version

• Dependencies: SDL2
• Tested OS: Linux, Windows
• Keyboard:
  • Up / Left / Down / Right: ↑, ←, ↓, →
  • Start / Select: Z, X
  • A / B: N, M
  • Break execution: B
  • VM debug panel (toggle): I
  • VRAM tiles / bg map / win map (toggle): 1, 2, 3
  • Quit: Esc

Screenshots

Materials

• Reference emulator:
  • https://bgb.bircd.org
• PDF:
  • https://gekkio.fi/files/gb-docs/gbctr.pdf
  • http://marc.rawer.de/Gameboy/Docs/GBCPUman.pdf
• Docs:
  • https://gbdev.gg8.se/
  • https://gbdev.io/pandocs/
  • https://rylev.github.io/DMG-01/public/book/cpu/register_data_instructions.html
  • https://www.pastraiser.com/cpu/gameboy/gameboy_opcodes.html
  • https://ez80.readthedocs.io/en/latest/docs/bit-shifts/rlca.html
  • https://realboyemulator.wordpress.com/2013/01/03/a-look-at-the-game-boy-bootstrap-let-the-fun-begin/
  • https://gist.github.com/SonoSooS/c0055300670d678b5ae8433e20bea595
• Test roms:
  • https://github.com/retrio/gb-test-roms/tree/master
  • https://github.com/c-sp/gameboy-test-roms

Missing:

• using actual nes controller
• more cartridge controller (mbc2, etc)
• save to ram
• debug snapshot
• reset
• serial port
• devices (camera, printer, etc)

Not 100%:

• wave + noise channels
• mode 3 + 0 length adjustments
• dma spread on 160 clocks

Bugs:

• wgpu/pixels rendering on OS-X + HiDPI