GB-Emulator

A Gameboy/Gameboy Color emulator written to learn about emulator programming.

Controls

• wasd - direction keys
• k - A button
• j - B button
• n - start
• b - select

Features

• Fully featured base Gameboy emulation that passes all mooneye-gb hardware tests (See below)
• Support for Gameboy Color features such as color, VRAM and WRAM banking, double speed mode, and partial HDMA support
• Emulation of saturated gameboy color screen
• Pixel FIFO based graphics processing unit allowing for cycle accurate graphics emulation
• Four channel audio processing unit with left and right panning
• Cycle accurate timer, serial and dma implementation
• Support for MBC1, MBC2, MBC3 and MBC5 cartridges
• Implementation of "real time clock (RTC)" hardware on MBC3

Images

Gameboy

Gameboy Color

Unimplemented

• OAM bug
• WX=167,00

Build

Requirements (64-bit Windows)

1. SDL2 Visual C++ development libraries

2. MSYS2 (GNU tools such as make)

3. clang++

MSYS2 and Clang

Install MSYS2. Using pacman in the msys2 shell, download the base development tools and clang++ using the following command:

pacman -S --needed base-devel mingw-w64-x86_64-clang

Compilation

Clone the repository and change directories:

git clone https://github.com/Khaidde/GB-Emulator
cd GB-Emulator

Run make in a msys2 mingw64 shell. Note that by default, the makefile uses "C:\SDL2\include" and "C:\SDL2\lib\x64" as the include and library path respectively. Flags can be provided to change these paths.

make SDL2_INCLUDE=C:/SDL2/include SDL2_LIB=C:/SDL2/lib/x64

Make targets:

• build (compile emulator into a runnable executable)
• test (compile emulator with tester options to run test suite)
• clean (remove all files from the build directory)

Other make variables include the following:

• BUILD_TYPE ("debug" or "release")
• BIN_DIR (output directory of the executable)
• OBJ_DIR (output directory of the object files)

Note: Build has only been tested on 64-bit Windows 10

ROM Tests

mooneye-gb tests (All passed)

bits

Test	Passed	Note
mem_oam	x
reg_f	x
unused_hwio-GS	x

instr

Test	Passed	Note
daa	x

interrupts

Test	Passed	Note
ie_push	x

oam_dma

Test	Passed	Note
basic	x
reg_read	x
sources-GS	x

ppu

Test	Passed	Note
hblank_ly_scx_timing-GS	x
intr_1_2_timing-GS	x
intr_2_0_timing	x
intr_2_mode0_timing	x
intr_2_mode0_timing_sprites	x
intr_2_mode3_timing	x
intr_2_oam_ok_timing	x
lcdon_timing-GS	x
lcdon_write_timing-GS	x
stat_irq_blocking	x
stat_lyc_onoff	x
vblank_stat_intr-GS	x

serial

Test	Passed	Note
boot_sclk_align_dmgABCmgb	x

timer

Test	Passed	Note
div_write	x
rapid_toggle	x
tim00	x
tim00_div_trigger	x
tim01	x
tim01_div_trigger	x
tim10	x
tim10_div_trigger	x
tim11	x
tim11_div_trigger	x
tima_reload	x
tima_write_reloading	x
tma_write_reloading	x

acceptance

Test	Passed	Note
add_sp_e_timing	x
boot_div-dmgABCmgb	x
boot_hwio-dmgABCmgb	x
boot_regs-dmgABC	x
call_cc_timing	x
call_cc_timing2	x
call_timing	x
call_timing2	x
di_timing-GS	x
div_timing	x
ei_sequence	x
halt_ime0_ei	x
halt_ime0_nointr_timing	x
halt_ime1_timing	x
halt_ime1_timing2-GS	x
if_ie_registers	x
intr_timing	x
jp_cc_timing	x
jp_timing	x
ld_hl_sp_e_timing	x
oam_dma_restart	x
oam_dma_start	x
oam_dma_timing	x
pop_timing	x
push_timing	x
rapid_di_ei	x
ret_cc_timing	x
ret_timing	x
reti_intr_timing	x
reti_timing	x
rst_timing	x

mbc1

Test	Passed	Note
bits_bank1	x
bits_bank2	x
bits_mode	x
bits_ramg	x
multicart_rom_8Mb		Unsupported
ram_64kb	x
ram_256kb	x
rom_512kb	x
rom_1Mb	x
rom_2Mb	x
rom_4Mb	x
rom_8Mb	x
rom_16Mb	x

mbc2

Test	Passed	Note
bits_ramg	x
bits_romb	x
bits_unused	x
ram	x
rom_512kb	x
rom_1Mb	x
rom_2Mb	x

mbc5

Test	Passed	Note
rom_512kb	x
rom_1Mb	x
rom_2Mb	x
rom_4Mb	x
rom_8Mb	x
rom_16Mb	x
rom_32Mb	x
rom_64Mb	x

manual-only

Test	Passed	Note
sprite_priority	x

Blargg tests

Test	Passed	Note
cpu_instrs	x
dmg_sound
instr_timing	x
mem_timing	x
mem_timing_2	x
oam_bug		oam bug ignored
halt_bug	x