From ac704e6934eb051001fa67c69d7e335e75c0ffe1 Mon Sep 17 00:00:00 2001 From: Ignacio Sanchez Gines <863613+drhelius@users.noreply.github.com> Date: Fri, 24 Jul 2026 13:24:29 +0200 Subject: [PATCH 1/5] Update Gearboy docs --- docs/library/gearboy.md | 51 ++++++++++++++++++++++++++--------------- 1 file changed, 33 insertions(+), 18 deletions(-) diff --git a/docs/library/gearboy.md b/docs/library/gearboy.md index db75c26687..a4e05e75cc 100644 --- a/docs/library/gearboy.md +++ b/docs/library/gearboy.md @@ -2,13 +2,14 @@ ## Background -Gearboy is an open source, cross-platform, Nintendo Game Boy (DMG) / Game Boy Color (GBC) emulator written in C++. +Gearboy is an open source, cross-platform Nintendo Game Boy (DMG), Game Boy Color (GBC), and Super Game Boy (SGB) emulator written in C++. -- Accurate emulation supporting cartridges: ROM, ROM + RAM, MBC1, MBC2, MBC3, MBC5, MBC7, HuC-1, HuC-3, MMM01, Pocket Camera, TAMA5 and MBC1M. +- Accurate emulation with support for ROM-only cartridges and MBC1, MBC1M, MBC2, MBC3, MBC5, MBC7, HuC-1, HuC-3, MMM01, Pocket Camera, TAMA5, Wisdom Tree, M161, Sachen MMC1/MMC2, PKJD, Bung/EMS, and Poke 2-in-1 mappers. - Game Boy Color support. -- Battery powered RAM save support. +- Super Game Boy support, including borders and color palettes. +- Battery-backed RAM save support. - Save states. -- Bootrom (BIOS) support. +- Boot ROM (BIOS) support. - Game Genie and GameShark cheat support. - 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. @@ -24,14 +25,14 @@ A summary of the licenses behind RetroArch and its cores can be found [here](../ ## BIOS -Gearboy does not require bootrom (BIOS) files to work but they can be used optionally. +Gearboy does not require boot ROM (BIOS) files, but they can be used optionally. -When the bootrom is enabled it will execute as in original hardware, causing invalid roms to lock or forcing hardware like GB Pocket or GBA, depending on the bootrom file. +When enabled, a boot ROM runs as it does on original hardware. Invalid ROMs may fail to boot, and the selected boot ROM may enable hardware differences for systems such as Game Boy Pocket or Game Boy Advance. Required or optional firmware files go in the frontend's system directory. !!! attention - If you’d like to use any bootrom, you can place the following files in RetroArch's system directory. Then, you need to enable [DMG Bootrom](#core-options) and/or [Game Boy Color Bootrom](#core-options) core options for these bootrom files to be used. + Place boot ROM files in RetroArch's system directory, then enable the [DMG Bootrom](#core-options) or [GBC Bootrom](#core-options) core option. | Filename | Description | md5sum | |:------------:|:----------------------------------:|:--------------------------------:| @@ -106,13 +107,12 @@ The Gearboy core saves/loads to/from these directories. ### Geometry and timing -- The Gearboy core's core provided FPS is 59.7275005696 -- The Gearboy core's core provided sample rate is 44100 Hz -- The Gearboy core's base width is 160 -- The Gearboy core's base height is 144 -- The Gearboy core's max width is 160 -- The Gearboy core's max height is 144 -- The Gearboy core's core provided aspect ratio is 10/9 +- The Gearboy core's provided FPS is 59.7275005696 +- The Gearboy core's provided sample rate is 44100 Hz +- The Gearboy core's base size is 160x144, or 256x224 when an SGB border is displayed +- The Gearboy core's max width is 256 +- The Gearboy core's max height is 224 +- The Gearboy core's provided aspect ratio is 10:9 without an SGB border and 8:7 with a border ## Core options @@ -124,15 +124,15 @@ Settings with (restart) means that core has to be closed for the new setting to Select which hardware/model is emulated. - - *Auto* selects the best hardware based on the rom. + - *Auto* selects the best hardware based on the ROM header. - *Game Boy DMG* forces original Game Boy hardware. - *Game Boy Advance* enables Game Boy Advance hardware. -- **Mapper (restart)** [gearboy_mapper] (**Auto**|ROM Only|MBC 1|MBC 2|MBC 3|MBC 5|MBC 1 Multicart|HuC 1|HuC 3|MMM01|Camera|MBC 7|TAMA5) +- **Mapper (restart)** [gearboy_mapper] (**Auto**|ROM Only|MBC 1|MBC 2|MBC 3|MBC 5|MBC 1 Multicart|HuC 1|HuC 3|MMM01|Camera|MBC 7|TAMA5|Wisdom Tree|M161|Sachen MMC1|Sachen MMC2|PKJD|Bung/EMS|Poke 2-in-1) Select which Memory Bank Controller (MBC or mapper) is emulated. - - *Auto* selects the best MBC based on the rom. + - *Auto* selects the best mapper based on the ROM header. - *ROM Only* forces no MBC. - *MBC 1* forces MBC 1. - *MBC 2* forces MBC 2. @@ -145,6 +145,21 @@ Settings with (restart) means that core has to be closed for the new setting to - *Camera* forces Pocket Camera. - *MBC 7* forces MBC 7. - *TAMA5* forces TAMA5. + - *Wisdom Tree* forces the Wisdom Tree mapper. + - *M161* forces the M161 mapper. + - *Sachen MMC1* forces the Sachen MMC1 mapper. + - *Sachen MMC2* forces the Sachen MMC2 mapper. + - *PKJD* forces the PKJD mapper. + - *Bung/EMS* forces the Bung/EMS flash cartridge mapper. + - *Poke 2-in-1* forces the Poke 2-in-1 mapper. + +- **Super Game Boy (restart)** [gearboy_sgb] (**Enabled**|Disabled) + + Run compatible games in Super Game Boy mode. Disable this option to run them as standard Game Boy games. + +- **Super Game Boy Border** [gearboy_sgb_border] (**Enabled**|Disabled) + + Display the Super Game Boy border around the game screen. Disable this option to show only the 160x144 game screen. - **DMG Palette** [gearboy_palette] (**Original**|Sharp|B/W|Autumn|Soft|Slime) @@ -164,7 +179,7 @@ Settings with (restart) means that core has to be closed for the new setting to - **Allow Up+Down / Left+Right** [gearboy_up_down_allowed] (**Disabled**|Enabled) - Allow pressing, quickly alternating, or holding both left and right (or up and down) directions at the same time. This may cause movement based glitches in certain games. + Allow pressing, quickly alternating, or holding both left and right, or up and down, at the same time. This may cause movement-based glitches in some games. - **Tilt Source (MBC7)** [gearboy_tilt_source] (**Mouse**|Sensor|Analog Stick) From d3c76fd00c081138448b645d56b0baded835472c Mon Sep 17 00:00:00 2001 From: Ignacio Sanchez Gines <863613+drhelius@users.noreply.github.com> Date: Fri, 24 Jul 2026 13:24:33 +0200 Subject: [PATCH 2/5] Update Gearsystem docs --- docs/library/gearsystem.md | 68 ++++++++++++++++++++++++-------------- 1 file changed, 44 insertions(+), 24 deletions(-) diff --git a/docs/library/gearsystem.md b/docs/library/gearsystem.md index dfd3674aff..cd952c9a28 100644 --- a/docs/library/gearsystem.md +++ b/docs/library/gearsystem.md @@ -2,15 +2,15 @@ ## Background -Gearsystem is an open source, cross-platform, Sega Master System / Game Gear / SG-1000 / Othello Multivision emulator written in C++. +Gearsystem is an open source, cross-platform Sega Master System, Game Gear, SG-1000, and Othello Multivision emulator written in C++. -- Very accurate emulation supporting cartridges: ROM, ROM + RAM, SEGA, Codemasters, Korean, MSX + Nemesis, Janggun, SG-1000, and many Korean multi-carts. +- Very accurate emulation with support for ROM-only cartridges and Sega, Codemasters, Korean, MSX, Janggun, SG-1000, EEPROM, and multicart mappers. - Automatic region detection: NTSC-JAP, NTSC-USA, PAL-EUR. - Accurate VDP emulation, including timing and VDP specifics for SMS, SMS2, GG and TMS9918 modes. - Support for YM2413 (OPLL) FM sound chip. - Light Phaser and Paddle Control support. - Internal database for ROM detection. -- Battery powered RAM save support. +- Battery-backed RAM save support. - Game Genie and Pro Action Replay cheat support. - 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. @@ -26,9 +26,9 @@ A summary of the licenses behind RetroArch and its cores can be found [here](../ ## BIOS -Gearsystem does not require BIOS (bootrom) files to work but they can be used optionally. +Gearsystem does not require BIOS (boot ROM) files, but they can be used optionally. -When the BIOS is enabled it will execute as in original hardware, causing invalid roms to lock or preventing them to boot, depending on the BIOS file and rom region and system. If you experience issues disable the BIOS. +When enabled, the BIOS runs as it does on original hardware. Invalid ROMs or ROMs for a different region or system may fail to boot. Disable the BIOS if this occurs. Required or optional firmware files go in the frontend's system directory. @@ -109,13 +109,13 @@ The Gearsystem core saves/loads to/from these directories. ### Geometry and timing -- The Gearsystem core's core provided FPS is 60 for NTSC games and 50 for PAL games -- The Gearsystem core's core provided sample rate is 44100 Hz +- The Gearsystem core's provided FPS is 60 for NTSC games and 50 for PAL games +- The Gearsystem core's provided sample rate is 44100 Hz - The Gearsystem core's base width is 256 for Master System / SG-1000 games and 160 for Game Gear games - The Gearsystem core's base height is 192 for Master System / SG-1000 games and 144 for Game Gear games -- The Gearsystem core's max width is 256 for Master System games and 160 for Game Gear games -- The Gearsystem core's max height is 224 for Master System games and 144 for Game Gear games -- The Gearsystem core's core provided aspect ratio is 4:3 for Master System / SG-1000 games and 10:9 for Game Gear games +- The Gearsystem core's max width is 320 +- The Gearsystem core's max height is 288 +- The Gearsystem core's provided aspect ratio is 4:3 for Master System / SG-1000 games and 10:9 for Game Gear games ## Core options @@ -127,7 +127,7 @@ Settings with (restart) means that core has to be closed for the new setting to Select the console type to emulate. 'Auto' automatically detects the appropriate system based on the loaded content. - - *Auto* selects the best hardware based on the rom. + - *Auto* selects the best hardware based on the ROM. - *Master System / Mark III* forces original Master System / Mark III hardware. - *Game Gear (2 ASIC)* forces Game Gear hardware with 2 ASIC configuration. - *Game Gear (2 ASIC) SMS Mode* forces Game Gear in SMS compatibility mode (2 ASIC). @@ -140,7 +140,7 @@ Settings with (restart) means that core has to be closed for the new setting to Select which region is emulated. - - *Auto* selects the best region based on the rom. + - *Auto* selects the best region based on the ROM. - *Master System Japan* forces Master System Japan region. - *Master System Export* forces Master System Export region. - *Game Gear Japan* forces Game Gear Japan region. @@ -151,7 +151,7 @@ Settings with (restart) means that core has to be closed for the new setting to Select which mapper (memory bank controller) is emulated. 'Auto' automatically detects the appropriate mapper based on the loaded content. Only change this if a game does not work correctly with the default setting. - - *Auto* selects the best mapper based on the rom. + - *Auto* selects the best mapper based on the ROM. - *ROM* forces no mapper. - *SEGA* forces SEGA mapper. - *Codemasters* forces Codemasters mapper. @@ -159,12 +159,28 @@ Settings with (restart) means that core has to be closed for the new setting to - *SG-1000* forces SG-1000 mapper. - *MSX* forces MSX mapper. - *Janggun* forces Janggun mapper. + - *Korean 2000 XOR 1F* forces the Korean 2000 XOR 1F mapper. + - *Korean MSX 32KB 2000* forces the Korean MSX 32KB 2000 mapper. + - *Korean MSX SMS 8000* forces the Korean MSX SMS 8000 mapper. + - *Korean SMS 32KB 2000* forces the Korean SMS 32KB 2000 mapper. + - *Korean MSX 8KB 0300* forces the Korean MSX 8KB 0300 mapper. + - *Korean 0000 XOR FF* forces the Korean 0000 XOR FF mapper. + - *Korean FFFF HiCom* forces the Korean FFFF HiCom mapper. + - *Korean FFFE* forces the Korean FFFE mapper. + - *Korean BFFC* forces the Korean BFFC mapper. + - *Korean FFF3 FFFC* forces the Korean FFF3 FFFC mapper. + - *Korean MD FFF5* forces the Korean MD FFF5 mapper. + - *Korean MD FFF0* forces the Korean MD FFF0 mapper. + - *Jumbo Dahjee* forces the Jumbo Dahjee mapper. + - *EEPROM 93C46* forces the EEPROM 93C46 mapper. + - *Multi 4PAK All Action* forces the Multi 4PAK All Action mapper. + - *Iratahack* forces the Iratahack mapper. - **Refresh Rate (restart)** [gearsystem_timing] (**Auto**|NTSC (60 Hz)|PAL (50 Hz)) Select which refresh rate will be used in emulation. - - *Auto* selects the best refresh rate based on the rom. + - *Auto* selects the best refresh rate based on the ROM. - *NTSC (60 Hz)* forces 60 Hz. - *PAL (50 Hz)* forces 50 Hz. @@ -194,26 +210,30 @@ Settings with (restart) means that core has to be closed for the new setting to - *Auto* hides the left bar when the bar is detected. - *Always* always hides the left bar even if no left bar is detected. +- **No Sprite Limit** [gearsystem_no_sprite_limit] (**Disabled**|Enabled) + + Remove the per-line sprite limit. This reduces flickering but may cause glitches in some games. + - **Master System BIOS (restart)** [gearsystem_bios_sms] (**Disabled**|Enabled) - Enable or disable the Master System BIOS. For this to work, the `bios.sms` file must exist in RetroArch's system directory. When enabled it will execute as in original hardware, which may cause invalid ROMs to lock or fail to boot. + Enable or disable the Master System BIOS. The `bios.sms` file must exist in the frontend's system directory. When enabled, it runs as it does on original hardware, so invalid ROMs may fail to boot. - **Game Gear BIOS (restart)** [gearsystem_bios_gg] (**Disabled**|Enabled) - Enable or disable the Game Gear BIOS. For this to work, the `bios.gg` file must exist in RetroArch's system directory. When enabled it will execute as in original hardware, which may cause invalid ROMs to lock or fail to boot. + Enable or disable the Game Gear BIOS. The `bios.gg` file must exist in the frontend's system directory. When enabled, it runs as it does on original hardware, so invalid ROMs may fail to boot. - **YM2413 (restart)** [gearsystem_ym2413] (**Auto**|Disabled) Enable or disable the YM2413 (OPLL) FM sound chip. 'Auto' enables the chip based on the loaded content. Some Master System games use this chip for enhanced music. - - *Auto* selects the best option based on the rom. + - *Auto* selects the best option based on the ROM. - *Disabled* disables YM2413. -- **PSG Volume** [gearsystem_psg_volume] (**100**|0 - 200) +- **PSG Volume** [gearsystem_psg_volume] (**100**|0-200 in increments of 10) Set the volume of the PSG (SN76489). The value is a percentage from 0 to 200, where 100 is the default volume. -- **FM Volume** [gearsystem_fm_volume] (**100**|0 - 200) +- **FM Volume** [gearsystem_fm_volume] (**100**|0-200 in increments of 10) Set the volume of the YM2413 (OPLL) FM sound chip. The value is a percentage from 0 to 200, where 100 is the default volume. @@ -227,17 +247,17 @@ Settings with (restart) means that core has to be closed for the new setting to - **Allow Up+Down / Left+Right** [gearsystem_up_down_allowed] (**Disabled**|Enabled) - Enabling this option allows pressing, quickly alternating, or holding both left and right (or up and down in some games) directions at the same time. + Enable this option to press, quickly alternate, or hold both left and right, or up and down, at the same time. - This may cause movement based glitches to occur in certain games. + This may cause movement-based glitches in some games. - It's best to keep this core option disabled. + It is best to keep this option disabled. - **Light Gun Input** [gearsystem_lightgun_input] (**Light Gun**|Touchscreen) Select which input will be used for Light Phaser games. - - *Light Gun* - Selects mouse-controlled 'Light Gun' input (devices will use [RetroLightgun](#lightgun) inputs). + - *Light Gun* - Selects mouse-controlled Light Gun input (devices will use [RetroLightgun](#light-gun) inputs). - *Touchscreen* - Selects a touchscreen input (devices will use [RetroPointer](#pointer) inputs instead). - **Light Gun Crosshair** [gearsystem_lightgun_crosshair] (**Disabled**|Enabled) @@ -285,7 +305,7 @@ Settings with (restart) means that core has to be closed for the new setting to | ![](../image/retropad/retro_a.png) | 2 | | ![](../image/retropad/retro_start.png) | Pause / Start | -## Lightgun +## Light Gun | RetroLightgun Inputs | [Light Phaser](https://segaretro.org/Light_Phaser) | |-----------------------|---------------------------------------------------------| From 83d6b4ec8acd568d5fdc4676c2f1043a1de95fbb Mon Sep 17 00:00:00 2001 From: Ignacio Sanchez Gines <863613+drhelius@users.noreply.github.com> Date: Fri, 24 Jul 2026 13:24:37 +0200 Subject: [PATCH 3/5] Update Gearcoleco docs --- docs/library/gearcoleco.md | 42 +++++++++++++++++++++----------------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/docs/library/gearcoleco.md b/docs/library/gearcoleco.md index b70608bac5..5aa5fb8432 100644 --- a/docs/library/gearcoleco.md +++ b/docs/library/gearcoleco.md @@ -2,19 +2,19 @@ ## Background -Gearcoleco is an open source, cross-platform, ColecoVision emulator written in C++. +Gearcoleco is an open source, cross-platform ColecoVision emulator written in C++. - Accurate Z80 core, including undocumented opcodes and behavior like R and MEMPTR registers. - Accurate TMS9918 emulation. -- Support for ColecoVision Super Game Module (SGM) and MegaCart ROMs. +- Support for ColecoVision Super Game Module (SGM) and Mega Cart ROMs. - Support for Super Action Controller (SAC), Wheel Controller and Roller Controller. - 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. -The Gearcoleco core has been authored by +The Gearcoleco core has been authored by: - [Nacho Sanchez (drhelius)](https://github.com/drhelius) -The Gearcoleco core is licensed under +The Gearcoleco core is licensed under: - [GPLv3](https://github.com/drhelius/Gearcoleco/blob/master/LICENSE) @@ -27,12 +27,14 @@ Gearcoleco requires a BIOS file to work. Required or optional firmware files go in the frontend's system directory. !!! attention - Gearcoleco emulator requires a ColecoVision BIOS. In order to get it to work you must place the following file in RetroArch's system directory. + Gearcoleco requires a ColecoVision BIOS. Place the following file in RetroArch's system directory. | Filename | Description | md5sum | |:-----------------:|:----------------------------------:|:--------------------------------:| | colecovision.rom | ColecoVision BIOS - Required | 2c66f5911e5b42b8ebe113403548eee7 | +If `colecovision.rom` is not found, the core also checks for `coleco.rom`. + ## Extensions Content that can be loaded by the Gearcoleco core have the following file extensions: @@ -79,7 +81,7 @@ Frontend-level settings or features that the Gearcoleco core respects. ### Directories -The Gearcoleco core's library name is 'Gearcoleco' +The Gearcoleco core's library name is 'Gearcoleco'. The Gearcoleco core saves/loads to/from these directories. @@ -97,11 +99,13 @@ The Gearcoleco core saves/loads to/from these directories. ### Geometry and timing -- The Gearcoleco core's core provided FPS is 60 for NTSC games and 50 for PAL games -- The Gearcoleco core's core provided sample rate is 44100 Hz -- The Gearcoleco core's width is 256 -- The Gearcoleco core's height is 192 -- The Gearcoleco core's core provided aspect ratio is 4:3 +- The Gearcoleco core's provided FPS is 60 for NTSC games and 50 for PAL games +- The Gearcoleco core's provided sample rate is 44100 Hz +- The Gearcoleco core's base width is 256 +- The Gearcoleco core's base height is 192 +- The Gearcoleco core's max width is 320 +- The Gearcoleco core's max height is 288 +- The Gearcoleco core's provided aspect ratio is 4:3 by default ## Core options @@ -113,7 +117,7 @@ Settings with (restart) means that core has to be closed for the new setting to Select which refresh rate will be used in emulation. - - *Auto* selects the best refresh rate based on the rom. + - *Auto* selects the best refresh rate based on the loaded ROM. - *NTSC (60 Hz)* forces 60 Hz. - *PAL (50 Hz)* forces 50 Hz. @@ -137,23 +141,23 @@ Settings with (restart) means that core has to be closed for the new setting to - **Allow Up+Down / Left+Right** [gearcoleco_up_down_allowed] (**Disabled**|Enabled) - Enabling this option allows pressing, quickly alternating, or holding both left and right (or up and down in some games) directions at the same time. + Enable this option to press, quickly alternate, or hold both left and right, or up and down, at the same time. - This may cause movement based glitches to occur in certain games. + This may cause movement-based glitches in some games. - It's best to keep this core option disabled. + It is best to keep this option disabled. - **No Sprite Limit** [gearcoleco_no_sprite_limit] (**Disabled**|Enabled) - Enabling this will remove the sprite limit in a single line. + Remove the per-line sprite limit. - This may cause glitches to occur in certain games. + This may cause glitches in some games. - It's best to keep this core option disabled. + It is best to keep this option disabled. - **Spinner Support** [gearcoleco_spinners] (**Disabled**|Super Action Controller|Wheel Controller|Roller Controller) - Select which controller will be used in emulation. Spinners are controlled by mouse movement. Mouse buttons are mapped to Left (Yellow) and Right (Red) buttons. + Select which spinner controller to emulate. Mouse movement controls the spinner. Mouse buttons map to the Left (Yellow) and Right (Red) buttons. - *Disabled* disables spinner support. - *Super Action Controller* enables spinner support for Super Action Controller. From 3eafbe3c0d54888a941f7d9589c0d9152843c2c4 Mon Sep 17 00:00:00 2001 From: Ignacio Sanchez Gines <863613+drhelius@users.noreply.github.com> Date: Fri, 24 Jul 2026 13:24:40 +0200 Subject: [PATCH 4/5] Update Geargrafx docs --- docs/library/geargrafx.md | 56 ++++++++++++++++++++++----------------- 1 file changed, 31 insertions(+), 25 deletions(-) diff --git a/docs/library/geargrafx.md b/docs/library/geargrafx.md index 249c6a06ee..7bdd99fe8f 100644 --- a/docs/library/geargrafx.md +++ b/docs/library/geargrafx.md @@ -2,7 +2,7 @@ ## Background -Geargrafx is an open source, cross-platform, PC Engine / TurboGrafx-16 / SuperGrafx emulator written in C++. +Geargrafx is an open source, cross-platform PC Engine, TurboGrafx-16, and SuperGrafx emulator written in C++. - Very accurate emulation supporting the entire HuCard PCE / SGX catalog. - Support for CD-ROM², Super CD-ROM² and Arcade CD-ROM² systems. @@ -13,16 +13,16 @@ Geargrafx is an open source, cross-platform, PC Engine / TurboGrafx-16 / SuperGr * Avenue Pad 3 (3 buttons, auto-configured based on game) * Avenue Pad 6 (6 buttons) - Adjustable scanline count (224p, 240p, or manual). -- RGB or Composite color output. -- Music rom support: HES. -- Internal database for automatic rom detection and hardware selection if `Auto` options are selected. +- Standard RGB, Turboxray, and Kitrinx color palettes. +- HES music ROM support. +- Internal database for automatic ROM detection and hardware selection when `Auto` is selected. - 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, etc.), OpenDingux, RetroFW and QNX. -The Geargrafx core has been authored by +The Geargrafx core has been authored by: - [Nacho Sanchez (drhelius)](https://github.com/drhelius) -The Geargrafx core is licensed under +The Geargrafx core is licensed under: - [GPLv3](https://github.com/drhelius/Geargrafx/blob/master/LICENSE) @@ -57,7 +57,7 @@ Content that can be loaded by the Geargrafx core have the following file extensi - .cue - .chd -Geargrafx supports `chd`, `cue/bin`, `cue/img` and `cue/iso` CD-ROM 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. +Geargrafx supports `chd`, `cue/bin`, `cue/img`, and `cue/iso` CD-ROM images. `cue/iso + wav` is also supported for 44.1 kHz, 16-bit stereo audio tracks. MP3 and OGG audio tracks are not supported. RetroArch database(s) that are associated with the Geargrafx core: @@ -98,7 +98,7 @@ Frontend-level settings or features that the Geargrafx core respects. ## Directories -The Geargrafx core's library name is 'Geargrafx' +The Geargrafx core's library name is 'Geargrafx'. The Geargrafx core saves/loads to/from these directories. @@ -118,9 +118,9 @@ The Geargrafx core saves/loads to/from these directories. - The Geargrafx core's provided FPS is 59.82 - The Geargrafx core's provided sample rate is 44100 Hz -- The Geargrafx core's base width is dependent on the content and overscan settings (Without overscan: 256, 341, 512. With overscan: 280, 373, 560) -- The Geargrafx core's base height is dependent on the ['Scanline Start' and 'Scanline End' core options](#core-options). -- The Geargrafx core's max width is 560 +- The Geargrafx core's base width depends on the video mode and overscan settings. Standard frames use 256, 341, or 512 pixels without overscan and 280, 373, or 560 pixels with overscan. Mixed-resolution frames use 1024 or 1120 pixels +- The Geargrafx core's base height depends on the ['Scanline Start' and 'Scanline End' core options](#core-options) +- The Geargrafx core's max width is 1120 - The Geargrafx core's max height is 242 - The Geargrafx core's provided aspect ratio is dependent on the ['Aspect Ratio' core option](#core-options). @@ -132,7 +132,7 @@ Settings with (restart) means that core has to be closed for the new setting to - **System (restart)** [geargrafx_console_type] (**Auto**|PC Engine (JAP)|SuperGrafx (JAP)|TurboGrafx-16 (USA)) - Select the console type to emulate. The default setting, Auto, automatically detects the appropriate console type based on the loaded content. + Select the console type to emulate. *Auto* detects the appropriate console type based on the loaded content. Many US games will not start if a Japanese system is detected. - **Aspect Ratio** [geargrafx_aspect_ratio] (**1:1 PAR**|4:3 DAR|6:5 DAR|16:9 DAR|16:10 DAR) @@ -167,9 +167,9 @@ Settings with (restart) means that core has to be closed for the new setting to This option will set the last scanline to be displayed. Scanline 241 is the last visible scanline. This option is only available when 'Scanline Count' is set to 'Manual'. -- **Composite Colors** [geargrafx_composite_colors] (**Disabled**|Enabled) +- **Color Palette** [geargrafx_palette] (**Standard RGB**|Turboxray|Kitrinx) - If enabled, the core will use composite colors instead of RGB colors. + Select the color palette used by the video encoder. - **No Sprite Limit** [geargrafx_no_sprite_limit] (**Disabled**|Enabled) @@ -179,7 +179,7 @@ Settings with (restart) means that core has to be closed for the new setting to Enable a low-pass video filter to simulate the signal degradation of analog video output on CRT displays. -- **Video LPF Intensity** [geargrafx_lowpass_intensity] (**100**|0 - 100) +- **Video LPF Intensity** [geargrafx_lowpass_intensity] (**100**|0-100 in increments of 10) Set the intensity of the video low-pass filter as a percentage from 0 to 100. @@ -220,7 +220,7 @@ Settings with (restart) means that core has to be closed for the new setting to - *Super CD-ROM* forces Super CD-ROM² system. - *Arcade CD-ROM* forces Arcade CD-ROM² system. -- **CD-ROM Bios (restart)** [geargrafx_cdrom_bios] (**Auto**|System Card 1|System Card 2|System Card 3|Game Express) +- **CD-ROM BIOS (restart)** [geargrafx_cdrom_bios] (**Auto**|System Card 1|System Card 2|System Card 3|Game Express) Specify the BIOS file to use for CD-ROM emulation. The *Auto* setting automatically selects the appropriate BIOS based on the loaded content. You can also manually choose one for compatibility with specific games. @@ -232,30 +232,28 @@ Settings with (restart) means that core has to be closed for the new setting to Enable the HuC6280A audio chip, as found in the SuperGrafx and CoreGrafx I. When disabled, the original HuC6280 chip from the PC Engine is used instead. -- **PSG Volume** [geargrafx_psg_volume] (**100**|0 - 200) +- **PSG Volume** [geargrafx_psg_volume] (**100**|0-200 in increments of 10) This option sets the volume of the PSG (Programmable Sound Generator) sound system. The value is a percentage from 0 to 200, where 100 is the default volume. -- **CD-ROM Volume** [geargrafx_cdrom_volume] (**100**|0 - 200) +- **CD-ROM Volume** [geargrafx_cdrom_volume] (**100**|0-200 in increments of 10) This option sets the volume of the CD-ROM sound system, which is used for music in CD-ROM games. The value is a percentage from 0 to 200, where 100 is the default volume. -- **ADPCM Volume** [geargrafx_adpcm_volume] (**100**|0 - 200) +- **ADPCM Volume** [geargrafx_adpcm_volume] (**100**|0-200 in increments of 10) This option sets the volume of the ADPCM sound system, which is typically used for speech in CD-ROM games. The value is a percentage from 0 to 200, where 100 is the default volume. - **Allow Up+Down / Left+Right** [geargrafx_up_down_allowed] (**Disabled**|Enabled) - Enabling this option allows pressing, quickly alternating, or holding both left and right (or up and down in some games) directions at the same time. - This may cause movement based glitches to occur in certain games. - It's best to keep this core option disabled. + Enable this option to press, quickly alternate, or hold both left and right, or up and down, at the same time. This may cause movement-based glitches in some games. - **Allow Soft Reset** [geargrafx_soft_reset] (**Enabled**|Disabled) - Pressing RUN and SELECT simultaneously on the PCE gamepad will SOFT RESET the console. This is the default hardware behavior. + Pressing RUN and SELECT simultaneously on the PCE gamepad will soft reset the console. This is the default hardware behavior. Disable this option if you want the soft reset functionality turned off. - **TurboTap** [geargrafx_turbotap] (**Disabled**|Enabled) @@ -266,6 +264,10 @@ Settings with (restart) means that core has to be closed for the new setting to Enable or disable MB128 backup memory support. MB128 is an external memory card device that can be used to save game data across multiple games. +- **Mouse Sensitivity** [geargrafx_mouse_sensitivity] (**5**|1-15) + + Adjust PC Engine Mouse sensitivity. Higher values move the cursor faster. + - **Avenue Pad 3 Switch** [geargrafx_avenue_pad_3_switch] (**Auto**|SELECT|RUN) Configure the button mapping for the Avenue Pad 3 controller's third button (III). @@ -274,6 +276,10 @@ Settings with (restart) means that core has to be closed for the new setting to - *SELECT* maps button III to SELECT. - *RUN* maps button III to RUN. +- **Turbo Toggle Hotkey (R2/L2)** [geargrafx_turbo_toggle_hotkey] (**Disabled**|Enabled) + + Use R2 to toggle Turbo I and L2 to toggle Turbo II for each player. When disabled, R2 and L2 are ignored. + - **P1 Turbo I** [geargrafx_turbo_p1_i] (**Disabled**|Enabled) Enables/disables the Turbo I button for Player 1. @@ -370,8 +376,8 @@ Settings with (restart) means that core has to be closed for the new setting to | ![](../image/retropad/retro_x.png) | | | IV | | ![](../image/retropad/retro_l1.png) | | | V | | ![](../image/retropad/retro_r1.png) | | | VI | -| ![](../image/retropad/retro_l2.png) | Toggle Turbo II | Toggle Turbo II | Toggle Turbo II | -| ![](../image/retropad/retro_r2.png) | Toggle Turbo I | Toggle Turbo I | Toggle Turbo I | +| ![](../image/retropad/retro_l2.png) | Toggle Turbo II when enabled | Toggle Turbo II when enabled | Toggle Turbo II when enabled | +| ![](../image/retropad/retro_r2.png) | Toggle Turbo I when enabled | Toggle Turbo I when enabled | Toggle Turbo I when enabled | ## External Links From fb6ea2bbf7c8c05660af8692e41e27189965d76a Mon Sep 17 00:00:00 2001 From: Ignacio Sanchez Gines <863613+drhelius@users.noreply.github.com> Date: Fri, 24 Jul 2026 13:24:46 +0200 Subject: [PATCH 5/5] Update Gearlynx docs --- docs/library/gearlynx.md | 37 ++++++++++++++++++++++--------------- 1 file changed, 22 insertions(+), 15 deletions(-) diff --git a/docs/library/gearlynx.md b/docs/library/gearlynx.md index a51e349468..c4024a24d3 100644 --- a/docs/library/gearlynx.md +++ b/docs/library/gearlynx.md @@ -2,13 +2,13 @@ ## Background -Gearlynx is an open source, cross-platform, Atari Lynx emulator written in C++. +Gearlynx is an open source, cross-platform Atari Lynx emulator written in C++. - Very accurate emulation supporting the entire commercial Atari Lynx catalog. - Bank switching (BANK1 + AUDIN) and EEPROM support. - Save files (EEPROM and NVRAM). - Configurable low-pass audio filter. -- Internal database for automatic rom detection and hardware selection if `Auto` options are selected. +- Internal database for automatic ROM detection and hardware selection when `Auto` is selected. - 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. The Gearlynx core has been authored by: @@ -79,7 +79,7 @@ Frontend-level settings or features that the Gearlynx core respects. ### Directories -The Gearlynx core's library name is 'Gearlynx' +The Gearlynx core's library name is 'Gearlynx'. The Gearlynx core saves/loads to/from these directories. @@ -97,12 +97,11 @@ The Gearlynx core saves/loads to/from these directories. ### Geometry and timing -- The Gearlynx core's core provided FPS is variable from 50 to 75 -- The Gearlynx core's core provided sample rate is 44100 Hz -- The Gearlynx core's base width is 160 -- The Gearlynx core's base height is 102 +- The Gearlynx core reports a dynamic refresh rate based on each game's timer configuration +- The Gearlynx core's provided sample rate is 44100 Hz +- The Gearlynx core's base size is 160x102 in horizontal mode and 102x160 in vertical mode - The Gearlynx core's max width is 160 -- The Gearlynx core's max height is 102 +- The Gearlynx core's max height is 160 - The Gearlynx core's provided aspect ratio is dependent on the ['Aspect Ratio' core option](#core-options). ## Core options @@ -137,33 +136,41 @@ Settings with (restart) means that core has to be closed for the new setting to - *Lynx I* forces emulation of the original Lynx model. - *Lynx II* forces emulation of the Lynx II model. +- **EEPROM Type (restart)** [gearlynx_eeprom_type] (**Auto**|None|93C46 - 128 B - 16-bit|93C46 - 128 B - 8-bit|93C56 - 256 B - 16-bit|93C56 - 256 B - 8-bit|93C66 - 512 B - 16-bit|93C66 - 512 B - 8-bit|93C76 - 1 KB - 16-bit|93C76 - 1 KB - 8-bit|93C86 - 2 KB - 16-bit|93C86 - 2 KB - 8-bit) + + Override the cartridge EEPROM capacity and organization. *Auto* uses the cartridge header or game database. Restart or reload the content to apply changes. + +- **Fast Sprite Rendering** [gearlynx_fast_sprite_rendering] (**Disabled**|Enabled) + + Use a simpler, faster sprite renderer. This is less accurate for mid-render interrupt effects used by some demos. + - **Audio Low-Pass Filter (Hz)** [gearlynx_lowpass_filter] (**3500**|500|1000|1500|2000|2500|3000|3500|4000|4500|5000) Configures a low-pass audio filter to reduce high-frequency noise. -- **Audio Channel 0 Volume** [gearlynx_audio_ch0_volume] (**100**|0-200) +- **Audio Channel 0 Volume** [gearlynx_audio_ch0_volume] (**100**|0-200 in increments of 10) Sets the volume level for audio channel 0 (percentage). -- **Audio Channel 1 Volume** [gearlynx_audio_ch1_volume] (**100**|0-200) +- **Audio Channel 1 Volume** [gearlynx_audio_ch1_volume] (**100**|0-200 in increments of 10) Sets the volume level for audio channel 1 (percentage). -- **Audio Channel 2 Volume** [gearlynx_audio_ch2_volume] (**100**|0-200) +- **Audio Channel 2 Volume** [gearlynx_audio_ch2_volume] (**100**|0-200 in increments of 10) Sets the volume level for audio channel 2 (percentage). -- **Audio Channel 3 Volume** [gearlynx_audio_ch3_volume] (**100**|0-200) +- **Audio Channel 3 Volume** [gearlynx_audio_ch3_volume] (**100**|0-200 in increments of 10) Sets the volume level for audio channel 3 (percentage). - **Allow Up+Down / Left+Right** [gearlynx_up_down_allowed] (**Disabled**|Enabled) - Enabling this option allows pressing, quickly alternating, or holding both left and right (or up and down) directions at the same time. + Enable this option to press, quickly alternate, or hold both left and right, or up and down, at the same time. - This may cause movement based glitches to occur in certain games. + This may cause movement-based glitches in some games. - It's best to keep this core option disabled. + It is best to keep this option disabled. ## Joypad