Skip to content

PC Engine / TurboGrafx-16 emulator and debugger for macOS, Windows, Linux, BSD and RetroArch.

License

Notifications You must be signed in to change notification settings

drhelius/Geargrafx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Geargrafx

GitHub Workflow Status GitHub Releases) commits) GitHub contributors GitHub Sponsors License Twitter Follow

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. If you find it useful, please consider sponsoring.

Don't hesitate to report bugs or ask for new features by opening an issue.

Downloads

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 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:
brew install sdl2
cd platforms/macos
make dist

Linux

  • Ubuntu / Debian / Raspberry Pi (Raspbian):
sudo apt install build-essential libsdl2-dev libglew-dev libgtk-3-dev
cd platforms/linux
make
  • Fedora:
sudo dnf install @development-tools gcc-c++ SDL2-devel glew-devel gtk3-devel
cd platforms/linux
make
  • Arch Linux:
sudo pacman -S base-devel sdl2 glew gtk3
cd platforms/linux
make

BSD

  • FreeBSD:
su root -c "pkg install -y git gmake pkgconf SDL2 glew lang/gcc gtk3"
cd platforms/bsd
gmake
  • NetBSD:
su root -c "pkgin install gmake pkgconf SDL2 glew lang/gcc gtk3"
cd platforms/bsd
gmake

Libretro

  • Ubuntu / Debian / Raspberry Pi (Raspbian):
sudo apt install build-essential
cd platforms/libretro
make
  • Fedora:
sudo dnf install @development-tools gcc-c++
cd platforms/libretro
make

Contributors

Thank you to all the people who have already contributed to Geargrafx!

Contributors

License

Geargrafx is licensed under the GNU General Public License v3.0 License, see LICENSE for more information.