This is a Game Boy Emulator written in C. The focus of this emulator will be to incorporate a wide variety of debugging facilities which allow users and developers To examine the code execution in multiple ways.
These specific features that this Game boy emulator will have are:
- Memory Viewer - Allows the user to see the Game Boy's memory and register status such as current instruction as well as step through the memory
- Memory Editor - Edit the Game Boy's memory on the fly and search for values within memory.
- Seperate window for graphics debugging that displays all of the VRAM memory related to graphics.
- cmocka is used for unit testing.
- SDL2 is used to create a cross platform grapgical interface.
- CLion IDE used for this project created by JetBrains. Though this IDE is used while implimenting the system, Any system with cmake should be able to compile the project.
Below is a list of resources that were/are being referenced during the design and implementation. Not all of these resources are complete on their own and some hardware resources are related to the Game Boy hardware but not strictly identical.
General Reference for memory locations, opcodes, and technical details for the Game Boy. While the opcode reference material is complete it describes the operations vaguely.
Reference table for opcodes. These tables describe the type of operation and orders them by opcode. This lists the type on instruction, the inputs as well as the instruction length and number of instruction cycles for execution.
Complete technical documents outlining the inner working of the Game Boy and Color Game Boy. This is a very good complete source but it a technical reference as opposed to an explanation of how or why certain things work the way they do. This is a good reference for checking completeness and proper functionality.
This is an opcode reference for the Z80 processor which is what the Game Boy's processor was designed after. There are several operations that work differently for the Game Boys processor however most are identical and the operations and side effects are described in much greater detail compared to the resources above.
This is a shorter summary than the Game Boy CPU instruction set but it a good source for verifying the correct usage of the opcodes.
This is a mirror containing test ROMs used to test various aspects of the emulator. These test ROMs are widely used to verify the quality of the emulator and includes test related to all aspects of Game Boy emulation such as timing and sound support.