Skip to content

Update Gear* emus docs #1114

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

Open
drhelius wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Gear* emus docs #1114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 8 additions & 4 deletions docs/library/gearboy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ Gearboy is an open source, cross-platform, Nintendo Game Boy (DMG) / Game Boy Co
- Accurate instruction and memory timing, passes instr_timing.gb and mem_timing.gb from blargg's tests.
- Supported cartridges: ROM, ROM + RAM, MBC1, MBC2, MBC3 + RTC, MBC5, HuC-1 and MBC1M (multicart).
- Accurate LCD controller emulation with correct timings and priorities including mid-scanline effects.
- Sound emulation using SDL Audio and [Gb_Snd_Emu library](http://slack.net/~ant/libs/audio.html#Gb_Snd_Emu).
- Game Boy Color support.
- Battery powered RAM save support.
- Save states.
- Game Genie and GameShark cheat support.
- Bootrom (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.

The Gearboy core has been authored by:

- [Ignacio Sanchez (drhelius)](https://github.com/drhelius)
- [Nacho Sanchez (drhelius)](https://github.com/drhelius)

The Gearboy core is licensed under:

Expand Down Expand Up @@ -67,7 +67,7 @@ Frontend-level settings or features that the Gearboy core respects.
| Saves | ✔ |
| States | ✔ |
| Rewind | ✔ |
| Netplay | ✕ |
| Netplay | ✔ |
| Core Options | ✔ |
| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✔ |
| RetroArch Cheats - Game Genie | ✔ |
Expand Down Expand Up @@ -147,6 +147,10 @@ Settings with (restart) means that core has to be closed for the new setting to

Select a color palette for Game Boy DMG games.

- **GBC Color Correction** [gearboy_color_correction] (**Disabled**|Enabled)

Enables color correction for Game Boy Color games to simulate the original GBC LCD screen output.

- **DMG Bootrom** [gearboy_bootrom_dmg] (**Disabled**|Enabled)

This option will enables/disables bootrom for Game Boy DMG model. For this to work, the `dmg_boot.bin` file must exist in Retro Arch's system directory.
Expand Down
4 changes: 2 additions & 2 deletions docs/library/gearcoleco.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Gearcoleco is an open source, cross-platform, ColecoVision emulator written in C

The Gearcoleco core has been authored by

- [Ignacio Sanchez (drhelius)](https://github.com/drhelius)
- [Nacho Sanchez (drhelius)](https://github.com/drhelius)

The Gearcoleco core is licensed under

Expand Down Expand Up @@ -57,7 +57,7 @@ Frontend-level settings or features that the Gearcoleco core respects.
| Saves | ✔ |
| States | ✔ |
| Rewind | ✔ |
| Netplay | ✕ |
| Netplay | ✔ |
| Core Options | ✔ |
| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✔ |
| RetroArch Cheats | ✕ |
Expand Down
50 changes: 35 additions & 15 deletions docs/library/geargrafx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,23 @@

Geargrafx is an open source, cross-platform, PC Engine / TurboGrafx-16 / SuperGrafx emulator written in C++.

- Accurate emulation supporting the entire HuCard PCE / SGX catalog
- CD-ROM², Super CD-ROM² and Arcade CD-ROM² systems
- Multi Tap support (up to 5 players)
- Accurate emulation supporting the entire HuCard PCE / SGX catalog.
- Support for CD-ROM², Super CD-ROM² and Arcade CD-ROM² systems.
- Backup RAM and Memory Base 128 support.
- Multi Tap support (up to 5 players).
- Controllers:
* Standard Gamepad (2 buttons)
* Avenue Pad 3 (3 buttons, auto-configured based on game)
* Avenue Pad 6 (6 buttons)
- Internal database for automatic rom detection and hardware selection if `Auto` options are selected
- Backup RAM support
- Save state support
- Retro Achievements support
- Adjustable scanline count (224p, 240p, or manual)
- RGB or Composite color output
- 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.
- 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

- [Ignacio Sanchez (drhelius)](https://github.com/drhelius)
- [Nacho Sanchez (drhelius)](https://github.com/drhelius)

The Geargrafx core is licensed under

Expand Down Expand Up @@ -54,6 +53,7 @@ Content that can be loaded by the Geargrafx core have the following file extensi

- .pce
- .sgx
- .hes
- .cue
- .chd

Expand All @@ -76,7 +76,7 @@ Frontend-level settings or features that the Geargrafx core respects.
| Saves | ✔ |
| States | ✔ |
| Rewind | ✔ |
| Netplay | ✕ |
| Netplay | ✔ |
| Core Options | ✔ |
| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✔ |
| RetroArch Cheats | ✔ |
Expand Down Expand Up @@ -180,9 +180,18 @@ Settings with (restart) means that core has to be closed for the new setting to

This option allows you to disable backup RAM (not recommended).

- **Deterministic Netplay** [geargrafx_deterministic_netplay] (**Disabled**|Enabled)

When enabled, ensures deterministic emulation behavior for netplay by setting consistent reset values for memory and hardware registers. This helps prevent desyncs during netplay sessions.

- **CD-ROM (restart)** [geargrafx_cdrom_type] (**Auto**|Standard|Super CD-ROM|Arcade CD-ROM)

Choose the type of CD-ROM system to emulate. The Auto setting automatically selects the appropriate CD-ROM type based on the loaded content.
Select the CD-ROM system type. The *Auto* setting automatically selects the appropriate CD-ROM system based on the loaded content.

- *Auto* selects the best CD-ROM system based on the content.
- *Standard* forces standard CD-ROM² system.
- *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)

Expand All @@ -192,9 +201,13 @@ Settings with (restart) means that core has to be closed for the new setting to

This option will preload all CD-ROM tracks in RAM. It will increase the memory usage of the core, but may improve performance.

- **HuC6280A Audio Chip** [geargrafx_psg_huc6280a] (**Enabled**|Disabled)

Enable or disable the HuC6280A audio chip emulation. The HuC6280A provides the PSG (Programmable Sound Generator) functionality.

- **PSG Volume** [geargrafx_psg_volume] (**100**|0 - 200)

This option sets the volume of the PSG sound system, which is used for sound effects and music in many games.
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)
Expand Down Expand Up @@ -222,10 +235,17 @@ Settings with (restart) means that core has to be closed for the new setting to

This option enables/disables TurboTap support (up to 5 players).

- **MB128 Backup Memory** [geargrafx_mb128] (**Auto**|Enabled|Disabled)

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.

- **Avenue Pad 3 Switch** [geargrafx_avenue_pad_3_switch] (**Auto**|SELECT|RUN)

When using the Avenue Pad 3 controller, you can set the switch to either *RUN* or *SELECT* with this option.
If you choose *Auto*, the emulator will select the best option based on the game being played.
Configure the button mapping for the Avenue Pad 3 controller's third button (III).

- *Auto* automatically selects the appropriate button mapping based on the game.
- *SELECT* maps button III to SELECT.
- *RUN* maps button III to RUN.

- **P1 Turbo I** [geargrafx_turbo_p1_i] (**Disabled**|Enabled)

Expand Down
13 changes: 7 additions & 6 deletions docs/library/gearsystem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,15 @@ Gearsystem is an open source, cross-platform, Sega Master System / Game Gear / S
- 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
- Internal database for rom detection.
- Light Phaser and Paddle Control support.
- Internal database for ROM detection.
- Battery powered RAM save support.
- Save states.
- 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.

The Gearsystem core has been authored by

- [Ignacio Sanchez (drhelius)](https://github.com/drhelius)
- [Nacho Sanchez (drhelius)](https://github.com/drhelius)

The Gearsystem core is licensed under

Expand Down Expand Up @@ -70,7 +69,7 @@ Frontend-level settings or features that the Gearsystem core respects.
| Saves | ✔ |
| States | ✔ |
| Rewind | ✔ |
| Netplay | ✕ |
| Netplay | ✔ |
| Core Options | ✔ |
| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✔ |
| RetroArch Cheats - Game Genie | ✔ |
Expand Down Expand Up @@ -145,7 +144,7 @@ Settings with (restart) means that core has to be closed for the new setting to
- *Game Gear Export* forces Game Gear Export region.
- *Game Gear International* forces Game Gear International region.

- **Mapper (restart)** [gearsystem_mapper] (**Auto**|ROM|SEGA|Codemasters|Korean|SG-1000)
- **Mapper (restart)** [gearsystem_mapper] (**Auto**|ROM|SEGA|Codemasters|Korean|MSX|Janggun|SG-1000)

Select which mapper (memory bank controller) is emulated.

Expand All @@ -154,6 +153,8 @@ Settings with (restart) means that core has to be closed for the new setting to
- *SEGA* forces SEGA mapper.
- *Codemasters* forces Codemasters mapper.
- *Korean* forces Korean mapper.
- *MSX* forces MSX mapper.
- *Janggun* forces Janggun mapper.
- *SG-1000* forces SG-1000 mapper.

- **Refresh Rate (restart)** [gearsystem_timing] (**Auto**|NTSC (60 Hz)|PAL (50 Hz))
Expand Down
Loading