re:GB is a hobby Nintendo Gameboy Emulator in C. Currently, the emulator lacks quite a few vital features including sound, state saving capabilities and also only MBC1 is supported as of now. I am working towards adding these features, especially audio. Anyways, to try it out follow the instructions below. Btw you would need to supply your own legally acquired ROM. re:GB does NOT supply Proprietary ROMS and will never do it in future too.
Clone the repo and build it yourself or download the precompiled binary. Once you have the binary run:
reGB [filepath]
NOTE: You need a bootrom to run this emulator. Create a directory roms and put the bootrom.gb file there. If you don't have any then download the bootrom from this repo's roms/ directory and put it in your local roms/ directory.
Both binary and roms/ (with bootrom.gb file inside it) should be in same directory.
| Joypad Keys | Mapping |
|---|---|
| A | Z |
| B | X |
| SELECT | RIGHT SHIFT |
| START | ENTER |
UP, DOWN, RIGHT & LEFT are mapped to corresponding ARROW KEYS on your keyboard
You need to have cmake and clang in order to build the project.
You also need python, poetry and optionally clang-format for auto-generating the CPU Backend and/or testing the project with JSON Tests.
Firstly, clone this repo along with its submodules. Then run the following command:
cd vcpkg && ./bootstrap-vcpkg.sh
Once that is done, run the commands:
cmake --preset [release | debug | test]
cmake --build --preset [release | debug | test]
- Use
releaseto generate a release build with optimizations. - Use
debugto generate a debug build. - Use
testto generate a shared object, used for loading in a python script to run JSON Tests.
This Emulator uses auto-generated CPU Instruction Handlers. See More.