Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drhelius/gearboy
Game Boy / Gameboy Color emulator and debugger for macOS, Windows, Linux, BSD and RetroArch.
https://github.com/drhelius/gearboy
bsd emulation emulator game-boy gameboy gameboy-color-emulator gameboy-emulator libretro linux nintendo-gameboy raspberry-pi retroarch
Last synced: 1 day ago
JSON representation
Game Boy / Gameboy Color emulator and debugger for macOS, Windows, Linux, BSD and RetroArch.
- Host: GitHub
- URL: https://github.com/drhelius/gearboy
- Owner: drhelius
- License: gpl-3.0
- Created: 2012-07-19T21:45:46.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-01-26T18:20:18.000Z (8 days ago)
- Last Synced: 2025-01-26T19:28:01.283Z (8 days ago)
- Topics: bsd, emulation, emulator, game-boy, gameboy, gameboy-color-emulator, gameboy-emulator, libretro, linux, nintendo-gameboy, raspberry-pi, retroarch
- Language: C++
- Homepage: https://x.com/drhelius
- Size: 67.4 MB
- Stars: 911
- Watchers: 48
- Forks: 139
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Gearboy
[](https://github.com/drhelius/Gearboy/actions/workflows/gearboy.yml)
[](https://github.com/drhelius/Gearboy/releases)
[](https://github.com/drhelius/Gearboy/commits/master)
[](https://github.com/drhelius/Gearboy/graphs/contributors)
[](https://github.com/sponsors/drhelius)
[](https://github.com/drhelius/Gearboy/blob/master/LICENSE)
[](https://x.com/drhelius)
Gearboy is a cross-platform Game Boy / Game Boy Color emulator written in C++ that runs on Windows, macOS, Linux, BSD and RetroArch.
This is an open source project with its ongoing development made possible thanks to the support by these awesome [backers](backers.md). If you find it useful, please, consider [sponsoring](https://github.com/sponsors/drhelius).
Don't hesitate to report bugs or ask for new features by [openning an issue](https://github.com/drhelius/Gearboy/issues).
## Downloads
- **Windows**:
- [Gearboy-3.6.1-windows-x64.zip](https://github.com/drhelius/Gearboy/releases/download/3.6.1/Gearboy-3.6.1-windows-x64.zip)
- [Gearboy-3.6.1-windows-arm64.zip](https://github.com/drhelius/Gearboy/releases/download/3.6.1/Gearboy-3.6.1-windows-arm64.zip)
- NOTE: If you have errors you may need to install:
- [Microsoft Visual C++ Redistributable](https://go.microsoft.com/fwlink/?LinkId=746572)
- [OpenGL Compatibility Pack](https://apps.microsoft.com/detail/9nqpsl29bfff)
- **macOS**:
- [Gearboy-3.6.1-macos-arm.zip](https://github.com/drhelius/Gearboy/releases/download/3.6.1/Gearboy-3.6.1-macos-arm.zip)
- [Gearboy-3.6.1-macos-intel.zip](https://github.com/drhelius/Gearboy/releases/download/3.6.1/Gearboy-3.6.1-macos-intel.zip)
- **Linux**:
- [Gearboy-3.6.1-ubuntu-24.04.zip](https://github.com/drhelius/Gearboy/releases/download/3.6.1/Gearboy-3.6.1-ubuntu-24.04.zip)
- [Gearboy-3.6.1-ubuntu-22.04.zip](https://github.com/drhelius/Gearboy/releases/download/3.6.1/Gearboy-3.6.1-ubuntu-22.04.zip)
- [Gearboy-3.6.1-ubuntu-20.04.zip](https://github.com/drhelius/Gearboy/releases/download/3.6.1/Gearboy-3.6.1-ubuntu-20.04.zip)
- NOTE: You may need to install `libsdl2` and `libglew`
- **RetroArch**: [Libretro core documentation](https://docs.libretro.com/library/gearboy/).
## Features
- Accurate CPU emulation, passes cpu_instrs.gb from blargg's tests.
- Accurate instruction and memory timing, passes instr_timing.gb and mem_timing.gb from blargg's tests.
- Supported cartridges: ROM, ROM + RAM, MBC1, MBC2, MBC3 + RTC, MBC5, HuC-1 and MBC1M (multicart).
- Accurate LCD controller emulation with correct timings and priorities including mid-scanline effects.
- Game Boy Color support.
- LCD screen ghosting effect as seen in the original Game Boy.
- LCD dot matrix effect.
- Battery powered RAM save support.
- Save states.
- Compressed rom support (ZIP).
- Bootrom (BIOS) support.
- *Game Genie* and *GameShark* cheat support.
- Supported platforms (standalone): Windows, Linux, BSD and macOS.
- Supported platforms (libretro): Windows, Linux, macOS, Raspberry Pi, Android, iOS, tvOS, PlayStation Vita, PlayStation 3, Nintendo 3DS, Nintendo GameCube, Nintendo Wii, Nintendo WiiU, Nintendo Switch, Emscripten, Classic Mini systems (NES, SNES, C64, ...), OpenDingux, RetroFW and QNX.
- Full debugger with just-in-time disassembler, cpu breakpoints, memory access breakpoints, code navigation (goto address, JP JR and CALL double clicking), debug symbols, memory editor, IO inspector and VRAM viewer including tiles, sprites, backgrounds and palettes.
- Windows and Linux *Portable Mode*.
- Rom loading from the command line by adding the rom path as an argument.
- Support for modern game controllers through [gamecontrollerdb.txt](https://github.com/gabomdq/SDL_GameControllerDB) file located in the same directory as the application binary.
## Tips
- *Boot ROM*: Gearboy can run with or without a Boot ROM. You can optionally load a Boot ROM and enable it.
- *Mouse Cursor*: Automatically hides when hovering main output window or when Main Menu is disabled.
- *Portable Mode*: Create an empty file named `portable.ini` in the same directory as the application binary to enable portable mode.
- *Docking windows*: In debug mode you can dock windows together by pressing SHIFT and drag'n drop a window into another.
- *Debug multi-viewport*: In Windows or macOS you can enable "multi-viewport" in debug menu. You must restart the emulator for the change to take effect. Once enabled you can drag debugger windows outside the main window.
- *Debug Symbols*: The emulator always tries to load a symbol file at the same time a rom is being loaded. For example, for ```path_to_rom_file.gb``` it tries to load ```path_to_rom_file.sym```. It is also possible to load a symbol file using the GUI or using the CLI.
- *Command Line Usage*: ```gearboy [rom_file] [symbol_file]```
## Build Instructions
### Windows
- Install Microsoft Visual Studio Community 2022 or later.
- Open the Gearboy Visual Studio solution `platforms/windows/Gearboy.sln` and build.
### macOS
- Install Xcode and run `xcode-select --install` in the terminal for the compiler to be available on the command line.
- Run these commands to generate a Mac *app* bundle:
``` shell
brew install sdl2
cd platforms/macos
make dist
```
### Linux
- Ubuntu / Debian / Raspberry Pi (Raspbian):
``` shell
sudo apt install build-essential libsdl2-dev libglew-dev libgtk-3-dev
cd platforms/linux
make
```
- Fedora:
``` shell
sudo dnf install @development-tools gcc-c++ SDL2-devel glew-devel gtk3-devel
cd platforms/linux
make
```
### BSD
- FreeBSD:
``` shell
su root -c "pkg install -y git gmake pkgconf SDL2 glew lang/gcc gtk3"
cd platforms/bsd
gmake
```
- NetBSD:
``` shell
su root -c "pkgin install gmake pkgconf SDL2 glew lang/gcc gtk3"
cd platforms/bsd
gmake
```
### Libretro
- Ubuntu / Debian / Raspberry Pi (Raspbian):
``` shell
sudo apt install build-essential
cd platforms/libretro
make
```
- Fedora:
``` shell
sudo dnf install @development-tools gcc-c++
cd platforms/libretro
make
```
## Accuracy Tests
Compared to other emulators: [see here](http://tasvideos.org/EmulatorResources/GBAccuracyTests.html).
Tests from [blargg's test roms](https://github.com/retrio/gb-test-roms):
## Screenshots
## Contributors
Thank you to all the people who have already contributed to Gearboy!
[]("https://github.com/drhelius/gearboy/graphs/contributors)
## License
Gearboy is licensed under the GNU General Public License v3.0 License, see [LICENSE](LICENSE) for more information.