Skip to content

Update docs for Gear* cores #1167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fpscan merged 5 commits into from
Jul 24, 2026
Merged

Update docs for Gear* cores #1167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ac704e6
Update Gearboy docs
drhelius Jul 24, 2026
d3c76fd
Update Gearsystem docs
drhelius Jul 24, 2026
83d6b4e
Update Gearcoleco docs
drhelius Jul 24, 2026
3eafbe3
Update Geargrafx docs
drhelius Jul 24, 2026
fb6ea2b
Update Gearlynx docs
drhelius Jul 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 33 additions & 18 deletions docs/library/gearboy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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 |
|:------------:|:----------------------------------:|:--------------------------------:|
Expand Down Expand Up @@ -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

Expand All @@ -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.
Expand All @@ -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)

Expand All @@ -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)

Expand Down
42 changes: 23 additions & 19 deletions docs/library/gearcoleco.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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:
Expand Down Expand Up @@ -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.

Expand All @@ -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

Expand All @@ -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.

Expand All @@ -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.
Expand Down
Loading
Loading