https://github.com/drhelius/geargrafx
PC Engine / TurboGrafx-16 emulator and debugger for macOS, Windows, Linux, BSD and RetroArch.
https://github.com/drhelius/geargrafx
bsd emulator libretro linux macos pc-engine pcengine raspberry-pi raspberrypi turbografx turbografx-16
Last synced: 2 months ago
JSON representation
PC Engine / TurboGrafx-16 emulator and debugger for macOS, Windows, Linux, BSD and RetroArch.
- Host: GitHub
- URL: https://github.com/drhelius/geargrafx
- Owner: drhelius
- License: gpl-3.0
- Created: 2024-01-02T22:54:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-08T22:00:00.000Z (2 months ago)
- Last Synced: 2025-04-08T22:23:23.642Z (2 months ago)
- Topics: bsd, emulator, libretro, linux, macos, pc-engine, pcengine, raspberry-pi, raspberrypi, turbografx, turbografx-16
- Language: C++
- Homepage: https://x.com/drhelius
- Size: 8.5 MB
- Stars: 59
- Watchers: 3
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Geargrafx
[](https://github.com/drhelius/Geargrafx/actions/workflows/geargrafx.yml)
[](https://github.com/drhelius/Geargrafx/releases)
[](https://github.com/drhelius/Geargrafx/commits/main)
[](https://github.com/drhelius/Geargrafx/graphs/contributors)
[](https://github.com/sponsors/drhelius)
[](https://github.com/drhelius/Geargrafx/blob/main/LICENSE)
[](https://x.com/drhelius)
Geargrafx is a cross-platform TurboGrafx-16 / PC Engine 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 [opening an issue](https://github.com/drhelius/Geargrafx/issues).
## Downloads
- **Windows**:
- [Geargrafx-1.0.0-windows-x64.zip](https://github.com/drhelius/Geargrafx/releases/download/1.0.0/Geargrafx-1.0.0-windows-x64.zip)
- [Geargrafx-1.0.0-windows-arm64.zip](https://github.com/drhelius/Geargrafx/releases/download/1.0.0/Geargrafx-1.0.0-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**:
- [Geargrafx-1.0.0-macos-arm.zip](https://github.com/drhelius/Geargrafx/releases/download/1.0.0/Geargrafx-1.0.0-macos-arm.zip)
- [Geargrafx-1.0.0-macos-intel.zip](https://github.com/drhelius/Geargrafx/releases/download/1.0.0/Geargrafx-1.0.0-macos-intel.zip)
- **Linux**:
- [Geargrafx-1.0.0-ubuntu-24.04.zip](https://github.com/drhelius/Geargrafx/releases/download/1.0.0/Geargrafx-1.0.0-ubuntu-24.04.zip)
- [Geargrafx-1.0.0-ubuntu-22.04.zip](https://github.com/drhelius/Geargrafx/releases/download/1.0.0/Geargrafx-1.0.0-ubuntu-22.04.zip)
- NOTE: You may need to install `libsdl2` and `libglew`
- **RetroArch**: [Libretro core documentation](https://docs.libretro.com/library/geargrafx/)
- **Dev Builds**: [GitHub Actions](https://github.com/drhelius/Geargrafx/actions/workflows/geargrafx.yml)
## Features
- Save states with preview.
- Compressed rom support (ZIP).
- 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, automatic labels, memory editor, PSG inspector and video viewer including registries, tiles, sprites and backgrounds.
- 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/mdqinc/SDL_GameControllerDB) file located in the same directory as the application binary.
## Tips
### Basic Usage
- **Mouse Cursor**: Automatically hides when hovering over the 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.
### Debugging Features
- **Docking Windows**: In debug mode, you can dock windows together by pressing SHIFT and dragging a window onto another.
- **Multi-viewport**: In Windows or macOS, you can enable "multi-viewport" in the 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 automatically tries to load a symbol file when loading a ROM. For example, for ```path_to_rom_file.rom``` it tries to load ```path_to_rom_file.sym```. You can also load a symbol file using the GUI or the CLI. It supports PCEAS, wla-dx and vasm file formats.
### Command Line Usage
```
geargrafx [rom_file] [symbol_file]
```
## Build Instructions
### Windows
- Install Microsoft Visual Studio Community 2022 or later.
- Open the Geargrafx Visual Studio solution `platforms/windows/Geargrafx.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
```
- Arch Linux:
``` shell
sudo pacman -S base-devel sdl2 glew gtk3
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
```
## Contributors
Thank you to all the people who have already contributed to Geargrafx!
[](https://github.com/drhelius/geargrafx/graphs/contributors)
## License
Geargrafx is licensed under the GNU General Public License v3.0 License, see [LICENSE](LICENSE) for more information.