|
1 | | -.:: Geargrafx ::. |
| 1 | + ____ __ |
| 2 | + / ___| ___ __ _ _ __ __ _ _ __ __ _ / _|_ __ |
| 3 | + | | _ / _ \/ _` | '__/ _` | '__/ _` | |_\ \/ / |
| 4 | + | |_| | __/ (_| | | | (_| | | | (_| | _|> < |
| 5 | + \____|\___|\__,_|_| \__, |_| \__,_|_| /_/\_\ |
| 6 | + |___/ |
| 7 | + |
| 8 | +A very accurate cross-platform TurboGrafx-16 / PC Engine / SuperGrafx / PCE CD-ROM² emulator |
2 | 9 | ----------------------------------------------------- |
3 | 10 | Instructions and tips at: |
4 | 11 | https://github.com/drhelius/Geargrafx |
5 | 12 | ----------------------------------------------------- |
6 | | -Geargrafx is in development. |
7 | | -Please, consider sponsoring (https://github.com/sponsors/drhelius) and following me on Twitter (http://twitter.com/drhelius) for updates. |
| 13 | +This is an open source project with its ongoing development made possible thanks to the support by awesome backers. |
| 14 | +Please, consider sponsoring: https://github.com/sponsors/drhelius |
| 15 | +Follow me on Twitter for updates: http://twitter.com/drhelius |
| 16 | +Don't hesitate to report bugs or ask for new features by opening an issue: https://github.com/drhelius/Geargrafx/issues |
8 | 17 | ----------------------------------------------------- |
9 | 18 | Features: |
10 | 19 |
|
| 20 | +- Accurate emulation supporting the entire HuCard PCE / SGX catalog. |
| 21 | +- Support for CD-ROM², Super CD-ROM² and Arcade CD-ROM² systems. |
| 22 | +- Save states with preview. |
| 23 | +- Backup RAM and Memory Base 128 support. |
| 24 | +- Multi Tap (up to 5 players). |
| 25 | +- Standard Gamepad (2 buttons), Avenue Pad 3 (3 buttons, auto-configured based on game), Avenue Pad 6 (6 buttons). |
| 26 | +- Adjustable scanline count (224p, 240p or manual). |
| 27 | +- RGB or Composite color output. |
| 28 | +- Compressed rom and CD images support (pce, sgx, cue, zip and chd). |
| 29 | +- Music rom support: HES. |
| 30 | +- VGM recorder. |
| 31 | +- Internal database for automatic rom detection and hardware selection if Auto options are selected. |
| 32 | +- Full debugger with just-in-time disassembler, CPU breakpoints, memory access breakpoints, code navigation, debug symbols, automatic labels, memory editor, PSG inspector and video viewer. |
| 33 | +- MCP server for AI-assisted debugging with GitHub Copilot, Claude, ChatGPT and similar, exposing tools for execution control, memory inspection, hardware status, and more. |
| 34 | +- Windows and Linux Portable Mode. |
| 35 | +- ROM loading from the command line by adding the ROM path as an argument. |
| 36 | +- ROM loading using drag & drop. |
| 37 | +- Support for modern game controllers through gamecontrollerdb.txt file located in the same directory as the application binary. |
| 38 | + |
| 39 | +----------------------------------------------------- |
| 40 | +Tips: |
| 41 | + |
| 42 | +Basic Usage: |
| 43 | +- BIOS: Geargrafx requires a BIOS to run CD-ROM games. It is possible to load any BIOS but the System Card 3.0 with md5 38179df8f4ac870017db21ebcbf53114 is recommended. |
| 44 | +- CD-ROM Images: Geargrafx supports chd, zipped and unzipped cue/bin, cue/img and cue/iso images. cue/iso + wav is also supported when audio track format is 44100Hz, 16 bit, stereo. It does not support MP3 or OGG audio tracks. |
| 45 | +- Mouse Cursor: Automatically hides when hovering over the main output window or when Main Menu is disabled. |
| 46 | +- Portable Mode: Create an empty file named portable.ini in the same directory as the application binary to enable portable mode. |
| 47 | + |
| 48 | +Debugging Features: |
| 49 | +- Docking Windows: In debug mode, you can dock windows together by pressing SHIFT and dragging a window onto another. |
| 50 | +- 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. |
| 51 | +- 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 symbol files using the GUI or the CLI. It supports PCEAS (old and new format), wla-dx and vasm file formats. |
| 52 | + |
| 53 | +Command Line Usage: |
| 54 | +geargrafx [options] [game_file] [symbol_file] |
| 55 | + |
| 56 | +Arguments: |
| 57 | + [game_file] Game file: accepts ROMs (.pce, .sgx, .hes), CUE (.cue) or ZIP (.zip) |
| 58 | + [symbol_file] Optional symbol file for debugging |
| 59 | + |
| 60 | +Options: |
| 61 | + -f, --fullscreen Start in fullscreen mode |
| 62 | + -w, --windowed Start in windowed mode with menu visible |
| 63 | + --mcp-stdio Auto-start MCP server with stdio transport |
| 64 | + --mcp-http Auto-start MCP server with HTTP transport |
| 65 | + --mcp-http-port N HTTP port for MCP server (default: 7777) |
| 66 | + -v, --version Display version information |
| 67 | + -h, --help Display this help message |
| 68 | + |
| 69 | +MCP Server: |
| 70 | +Geargrafx includes a Model Context Protocol (MCP) server that enables AI-assisted debugging through AI agents like GitHub Copilot, Claude, ChatGPT and similar. The server provides tools for execution control, memory inspection, breakpoints, disassembly, hardware status, sprite viewing, and more. |
| 71 | +For complete setup instructions and tool documentation, see MCP_README.md at https://github.com/drhelius/Geargrafx |
| 72 | + |
11 | 73 | ----------------------------------------------------- |
12 | 74 | Geargrafx is licensed under the GNU General Public License v3.0 License: |
13 | 75 |
|
|
0 commit comments