alexwennerberg / mooneye-gb

A Game Boy research project and emulator written in Rust

Mooneye GB

Mooneye GB is a Game Boy research project and emulator written in Rust.

The main goals of this project are accuracy and documentation. Some existing emulators are very accurate (Gambatte, BGB >= 1.5) but are not documented very clearly, so they are not that good references for emulator developers. I want this project to document as clearly as possible why certain behaviour is emulated in a certain way. This also means writing a lot of test ROMs to figure out corner cases and precise behaviour on real hardware.

For documentation about known behaviour, see Game Boy: Complete Technical Reference

Binary test ROMs are available here in a zip package and also as individual .gb files. They are automatically built and deployed whenever there's new changes in the master branch.

Non-goals:

• CGB (Game Boy Color) support. It would be nice, but I want to make the normal Game Boy support extremely robust first.
• A debugger
• A good user interface. Building native UIs with Rust is a bit painful at the moment.

Warning:

• Project is WIP
• Doesn't work properly without a boot ROM
• The emulator is lagging behind hardware research. I don't want to spend time making short-lived and probably incorrect fixes to the emulator if I'm not sure about the hardware behaviour.

Hardware testing

There's tons of documentation and tons of emulators in the internet, but in the end I only trust real hardware. I follow a fairly "scientific" process when developing emulation for a feature:

1. Think of different ways how it might behave on real hardware
2. Make a hypothesis based on the most probable behaviour
3. Write a test ROM for such behaviour
4. Run the test ROM on real hardware. If the test ROM made an invalid hypothesis, go back to 1.
5. Replicate the behaviour in the emulator

All test ROMs are manually run with these devices:

Device	Model	Mainboard	CPU	Detailed information
Game Boy	DMG-01	DMG-CPU-01	DMG-CPU	G01176542
Game Boy	DMG-01	DMG-CPU-02	DMG-CPU A	G02487032
Game Boy	DMG-01	DMG-CPU-04	DMG-CPU B	G10888299
Game Boy	DMG-01	DMG-CPU-06	DMG-CPU C	GM6058180
Super Game Boy	SHVC-027	SGB-R-10	SGB-CPU-01	SGB Unit #2 [gekkio]
Game Boy Pocket	MGB-001	MGB-CPU-01	CPU MGB	M10280516
Super Game Boy 2	SHVC-042	SHVC-SGB2-01	CPU SGB2	SGB2 Unit #1 [gekkio]
Game Boy Color	CGB-001	CGB-CPU-01	CPU CGB	C10203977
Game Boy Color	CGB-001	CGB-CPU-01	CPU CGB A	C10400331
Game Boy Color	CGB-001	CGB-CPU-02	CPU CGB B	C11778414
Game Boy Color	CGB-001	CGB-CPU-03	CPU CGB C	CGB Unit #1 [gekkio]
Game Boy Color	CGB-001	CGB-CPU-05	CPU CGB D	CH20983903
Game Boy Color	CGB-001	CGB-CPU-06	CPU CGB E	CH24224683
Game Boy Advance	AGB-001	AGB-CPU-01	CPU AGB	AH10045235
Game Boy Advance	AGB-001	AGB-CPU-10	CPU AGB A	AH12465671
Game Boy Player	DOL-017	DOL-GBS-20	CPU AGB A E	GBS Unit #3 [gekkio]
Game Boy Advance SP	AGS-001	C/AGS-CPU-01	CPU AGB B	XJH10027945
Game Boy Advance SP	AGS-001	C/AGS-CPU-21	CPU AGB B E	XEH17807928

Additional devices

I also have access to more devices with different mainboard revisions, but I think the CPU revision is all that matters if we study the behaviour and not analog characteristics (e.g. audio filtering). Even if audio sounded different between two units with the same CPU revision but different mainboard revisions, I'd expect the difference to be caused by individual device variation or different revisions of support chips (e.g. RAM/AMP/REG).

The main "test fleet" is already very big, so I will only use these devices if there's evidence of behaviour that depends on mainboard revision or individual units.

Device	Model	Mainboard	CPU	Detailed information
Game Boy	DMG-01	DMG-CPU-01	DMG-CPU	G01036814
Game Boy	DMG-01	DMG-CPU-03	DMG-CPU B	G06551776
Game Boy	DMG-01	DMG-CPU-05	DMG-CPU B	G13289095
Game Boy	DMG-01	DMG-CPU-06	DMG-CPU B
Game Boy	DMG-01	DMG-CPU-07	DMG-CPU B (blob)	G38953646
Game Boy	DMG-01	DMG-CPU-08	DMG-CPU C (blob)
Super Game Boy	SNSP-027	SGB-R-10	SGB-CPU-01	SGB Unit #7 [gekkio]
Game Boy Pocket	MGB-001	MGB-ECPU-01	CPU MGB	MH12573718
Game Boy Pocket	MGB-001	MGB-LCPU-01	CPU MGB	M12827347
Game Boy Pocket	MGB-001	MGB-LCPU-02	CPU MGB	MH20284468
Game Boy Light	MGB-101	MGL-CPU-01	CPU MGB	L10610653
Game Boy Color	CGB-001	CGB-CPU-04	CPU CGB D	C19220030
Game Boy Advance	AGB-001	AGB-CPU-02	CPU AGB	AJ12569062
Game Boy Advance	AGB-001	AGB-CPU-03	CPU AGB A	AJ14804298
Game Boy Advance	AGB-001	AGB-CPU-04	CPU AGB A	AJ15529163
Game Boy Player	DOL-017	DOL-GBS-10	CPU AGB A	GBS Unit #1 [gekkio]
Game Boy Advance SP	AGS-001	C/AGS-CPU-10	CPU AGB B	XEH12776954
Game Boy Advance SP	AGS-001	C/AGS-CPU-11	CPU AGB B	XJF10485171
Game Boy Advance SP	AGS-001	C/AGS-CPU-30	CPU AGB B E	XEH20137204
Game Boy Advance SP	AGS-101	C/AGT-CPU-01	CPU AGB B E	XU72764025-1

I'm still looking for the following mainboards, but these are probably not required for reverse engineering:

• SGB-R-01
• SGB-N-01
• SGB-N-10
• C/AGS-CPU-20
• DOL-GBS-01

For now, the focus is on DMG/MGB/SGB/SGB2 emulation, so not all tests pass on CGB/AGB/AGS or emulators emulating those devices.

Performance

Always compile in release mode if you care about performance!

On a i7-3770K desktop machine I can usually run ROMs with 2000 - 4000% speed. Without optimizations the speed drops to 150 - 200%, which is still fine for development purposes.

Raspberry Pi with X11 desktop works but is too slow because there is no OpenGL acceleration.

The emulator is runnable on Android, but cross-compiling and packaging is a huge pain and touch controls would have to be implemented, so I'm not supporting Android at the moment.

Running the emulator

Requirements:

• Rust 1.26
• SDL2 development libraries for your platform must be installed

GUI

1. cargo run --release
2. Follow the instructions

Command-line

1. Acquire a Game Boy bootrom, and put it to $HOME/.local/share/mooneye-gb/bootroms/dmg_boot.bin
2. cargo build --release
3. cargo run --release -- PATH_TO_GAMEBOY_ROM

On Windows, also download an SDL2 package containing SDL2.dll, and put it to target/debug and target/release.

Game Boy keys

Game Boy	Key
Dpad	Arrow keys
A	Z
B	X
Start	Return
Select	Backspace

Other keys

Function	Key
Fast forward	Shift
Toggle performance overlay	F2

Test suite

Blargg's tests

Test	mooneye-gb
cpu instrs	👍
dmg sound 2	❌
instr timing	👍
mem timing 2	👍
oam bug 2	❌
cgb sound 2

Notes:

• cpu_instrs fails on MGB/SGB2 hardware and emulators emulating them correctly. The ROM incorrectly detects the device as CGB, and attempts to perform a CPU speed change which causes a freeze (STOP instruction with joypad disabled)
• dmg_sound-2 test #10 can fail randomly on real hardware and seems to depend on non-deterministic behaviour.
• oam_bug-2 fails on all CGB, AGB, and AGS devices
• cgb_sound-2 test #03 fails on CPU CGB, CPU CGB A, and CPU CGB B

Mooneye GB acceptance tests

Test	mooneye-gb
add sp e timing	👍
boot div dmg0	❌
boot div dmgABCmgb	❌
boot div S	❌
boot div2 S	❌
boot hwio dmg0	❌
boot hwio dmgABCmgb	❌
boot hwio S	👍
boot regs dmg0	👍
boot regs dmgABC	👍
boot regs mgb	👍
boot regs sgb	👍
boot regs sgb2	👍
call timing	👍
call timing2	👍
call cc_timing	👍
call cc_timing2	👍
di timing GS	👍
div timing	👍
ei sequence	👍
ei timing	👍
halt ime0 ei	👍
halt ime0 nointr_timing	👍
halt ime1 timing	👍
halt ime1 timing2 GS	👍
if ie registers	👍
intr timing	👍
jp timing	👍
jp cc timing	👍
ld hl sp e timing	👍
oam dma_restart	👍
oam dma start	👍
oam dma timing	👍
pop timing	👍
push timing	👍
rapid di ei	👍
ret timing	👍
ret cc timing	👍
reti timing	👍
reti intr timing	👍
rst timing	👍

Bits (unusable bits in memory and registers)

Test	mooneye-gb
mem oam	👍
reg f	👍
unused_hwio GS	👍

Instructions

Test	mooneye-gb
daa	👍

Interrupt handling

Test	mooneye-gb
ie push	👍

OAM DMA

Test	mooneye-gb
basic	👍
reg_read	👍
sources GS	👍

PPU

Test	mooneye-gb
hblank ly scx timing GS	👍
intr 1 2 timing GS	👍
intr 2 0 timing	👍
intr 2 mode0 timing	👍
intr 2 mode3 timing	👍
intr 2 oam ok timing	👍
intr 2 mode0 timing sprites	❌
lcdon timing GS	❌
lcdon write timing GS	❌
stat irq blocking	❌
stat lyc onoff	❌
vblank stat intr GS	👍

Serial

Test	mooneye-gb
boot sclk align dmgABCmgb	❌

Timer

Test	mooneye-gb
div write	👍
rapid toggle	👍
tim00 div trigger	👍
tim00	👍
tim01 div trigger	👍
tim01	👍
tim10 div trigger	👍
tim10	👍
tim11 div trigger	👍
tim11	👍
tima reload	👍
tima write reloading	👍
tma write reloading	👍

Mooneye GB emulator-only tests

MBC1

Test	mooneye-gb
bits bank1	👍
bits bank2	👍
bits mode	👍
bits ramg	👍
rom 512kb	👍
rom 1Mb	👍
rom 2Mb	👍
rom 4Mb	👍
rom 8Mb	👍
rom 16Mb	👍
ram 64kb	👍
ram 256kb	👍
multicart rom 8Mb	👍

MBC2

Test	mooneye-gb
bits ramg	👍
bits romb	👍
bits unused	👍
rom 512kb	👍
rom 1Mb	👍
rom 2Mb	👍
ram	👍

MBC5

Test	mooneye-gb
rom 512kb	👍
rom 1Mb	👍
rom 2Mb	👍
rom 4Mb	👍
rom 8Mb	👍
rom 16Mb	👍
rom 32Mb	👍
rom 64Mb	👍

Mooneye GB manual tests

Test	mooneye-gb
sprite priority	👍

Mooneye GB misc tests

Test	mooneye-gb
boot div A
boot div cgb0
boot div cgbABCDE
boot hwio C
boot regs A
boot regs cgb

Bits

Test	mooneye-gb
unused hwio C

PPU

Test	mooneye-gb
vblank stat intr C

Test naming

Some tests are expected to pass only a single model:

• dmg = Game Boy
• mgb = Game Boy Pocket
• sgb = Super Game Boy
• sgb2 = Super Game Boy 2
• cgb = Game Boy Color
• agb = Game Boy Advance
• ags = Game Boy Advance SP

In addition to model differences, CPU revisions can affect the behaviour. Revision 0 refers always to the initial version of a CPU (e.g. CPU CGB). AGB and AGS use the same CPU models. The following CPU models have several revisions:

• DMG: 0, A, B, C
• CGB: 0, A, B, C, D, E
• AGB: 0, A, A E, B, B E. Revision E also exists, but only in Game Boy Micro (OXY) so it is out of this project's scope. However, A E and B E are most likely actually just E revision in A or B-compatible package.

In general, hardware can be divided to a couple of groups based on their behaviour. Some tests are expected to pass on a single or multiple groups:

• G = dmg+mgb
• S = sgb+sgb2
• C = cgb+agb+ags
• A = agb+ags

For example, a test with GS in the name is expected to pass on dmg+mgb + sgb+sgb2.

License and copyright

Mooneye GB is licensed under GPLv3+. Copyright (C) 2014-2019 Joonas Javanainen [e-mail]

The test framework and hardware tests under tests/ are licensed under MIT. Copyright (C) 2014-2019 Joonas Javanainen [e-mail]