Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 1.01 KB

README.md

File metadata and controls

18 lines (14 loc) · 1.01 KB

Mikan banner

Mikan

Mikan (ミカン) is a free, cross-platform, and open source Gameboy emulator project. It aims to be high performance, as close to standard as possible, and provide useful debugging tools for Gameboy developers and reverse engineers.

Building

Building has been tested on Ubuntu and Windows.

Build commands

git submodule update --init --recursive
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
cmake --build . --config Release --target app

Resources

There was two primary resources used while developing the emulator, that was the Gameboy Development Wiki and the Game Boy CPU Manual. Each core component of the emulator is modeled after and accompanied with documentation from these resources. Reading the code and comments of the core module might aswell be reading the wiki.