Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
79 changes: 65 additions & 14 deletions docs/library/gearboy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,7 @@

Gearboy is an open source, cross-platform, Nintendo Game Boy (DMG) / Game Boy Color (GBC) emulator written in C++.

- Accurate CPU emulation, passes cpu_instrs.gb from blargg's tests.
- 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.
- Accurate emulation supporting cartridges: ROM, ROM + RAM, MBC1, MBC2, MBC3, MBC5, MBC7, HuC-1, HuC-3, MMM01, Pocket Camera, TAMA5 and MBC1M.
- Game Boy Color support.
- Battery powered RAM save support.
- Save states.
Expand Down Expand Up @@ -77,7 +74,7 @@ Frontend-level settings or features that the Gearboy core respects.
| Remapping | ✔ |
| Multi-Mouse | ✕ |
| Rumble | ✕ |
| Sensors | |
| Sensors | |
| Camera | ✕ |
| Location | ✕ |
| Subsystem | ✕ |
Expand Down Expand Up @@ -131,17 +128,23 @@ Settings with (restart) means that core has to be closed for the new setting to
- *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)
- **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)

Select which Memory Bank Controller (MBC or mapper) is emulated.

- *Auto* selects the best MBC based on the rom.
- *ROM Only* forces no MBC.
- *MBC 1* forces MBC 1.
- *MBC 2* forces MBC 2.
- *MBC 3* forces MBC 3 + RTC.
- *MBC 3* forces MBC 3.
- *MBC 5* forces MBC 5.
- *MBC 1 Multicart* forces MBC 1 Multicart.
- *HuC 1* forces HuC 1.
- *HuC 3* forces HuC 3.
- *MMM01* forces MMM01.
- *Camera* forces Pocket Camera.
- *MBC 7* forces MBC 7.
- *TAMA5* forces TAMA5.

- **DMG Palette** [gearboy_palette] (**Original**|Sharp|B/W|Autumn|Soft|Slime)

Expand All @@ -151,21 +154,69 @@ Settings with (restart) means that core has to be closed for the new setting to

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

- **DMG Bootrom** [gearboy_bootrom_dmg] (**Disabled**|Enabled)
- **DMG Bootrom (restart)** [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.
Enable or disable the original Game Boy bootrom. For this to work, the `dmg_boot.bin` file must exist in RetroArch's system directory.

- **Game Boy Color Bootrom** [gearboy_bootrom_gbc] (**Disabled**|Enabled)
- **GBC Bootrom (restart)** [gearboy_bootrom_gbc] (**Disabled**|Enabled)

This option will enables/disables bootrom for Game Boy Color model. For this to work, the `cgb_boot.bin` file must exist in Retro Arch's system directory.
Enable or disable the Game Boy Color bootrom. For this to work, the `cgb_boot.bin` file must exist in RetroArch's system directory.

- **Allow Up+Down / Left+Right** [gearboy_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.
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.

This may cause movement based glitches to occur in certain games.
- **Tilt Source (MBC7)** [gearboy_tilt_source] (**Mouse**|Sensor|Analog Stick)

It's best to keep this core option disabled.
Select the input source for MBC7 tilt controls.

- **Sensor Sensitivity X (MBC7)** [gearboy_sensor_sensitivity_x] (**5**|1-10)

Set the horizontal sensitivity when using sensor input for MBC7 tilt controls.

- **Sensor Sensitivity Y (MBC7)** [gearboy_sensor_sensitivity_y] (**5**|1-10)

Set the vertical sensitivity when using sensor input for MBC7 tilt controls.

- **Sensor Invert X (MBC7)** [gearboy_sensor_invert_x] (**Disabled**|Enabled)

Invert the horizontal axis when using sensor input for MBC7 tilt controls.

- **Sensor Invert Y (MBC7)** [gearboy_sensor_invert_y] (**Disabled**|Enabled)

Invert the vertical axis when using sensor input for MBC7 tilt controls.

- **Mouse Sensitivity X (MBC7)** [gearboy_mouse_sensitivity_x] (**5**|1-10)

Set the horizontal sensitivity when using mouse input for MBC7 tilt controls.

- **Mouse Sensitivity Y (MBC7)** [gearboy_mouse_sensitivity_y] (**5**|1-10)

Set the vertical sensitivity when using mouse input for MBC7 tilt controls.

- **Mouse Invert X (MBC7)** [gearboy_mouse_invert_x] (**Disabled**|Enabled)

Invert the horizontal axis when using mouse input for MBC7 tilt controls.

- **Mouse Invert Y (MBC7)** [gearboy_mouse_invert_y] (**Disabled**|Enabled)

Invert the vertical axis when using mouse input for MBC7 tilt controls.

- **Analog Sensitivity X (MBC7)** [gearboy_analog_sensitivity_x] (**5**|1-10)

Set the horizontal sensitivity when using analog stick input for MBC7 tilt controls.

- **Analog Sensitivity Y (MBC7)** [gearboy_analog_sensitivity_y] (**5**|1-10)

Set the vertical sensitivity when using analog stick input for MBC7 tilt controls.

- **Analog Invert X (MBC7)** [gearboy_analog_invert_x] (**Disabled**|Enabled)

Invert the horizontal axis when using analog stick input for MBC7 tilt controls.

- **Analog Invert Y (MBC7)** [gearboy_analog_invert_y] (**Disabled**|Enabled)

Invert the vertical axis when using analog stick input for MBC7 tilt controls.

## Joypad

Expand Down
35 changes: 31 additions & 4 deletions docs/library/geargrafx.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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.
- Very 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).
Expand Down Expand Up @@ -173,8 +173,31 @@ Settings with (restart) means that core has to be closed for the new setting to

- **No Sprite Limit** [geargrafx_no_sprite_limit] (**Disabled**|Enabled)

Enabling this option removes the per-line sprite limit, but may cause glitches in certain games.
It's best to keep this core option disabled.
Remove the per-line sprite limit. This reduces flickering but may cause glitches in certain games. It's best to keep this option disabled.

- **Video Low-Pass Filter** [geargrafx_lowpass_filter] (**Disabled**|Enabled)

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)

Set the intensity of the video low-pass filter as a percentage from 0 to 100.

- **Video LPF Cutoff** [geargrafx_lowpass_cutoff] (**5.0 MHz**|3.0 MHz|3.5 MHz|4.0 MHz|4.5 MHz|5.0 MHz|5.5 MHz|6.0 MHz|6.5 MHz|7.0 MHz)

Set the cutoff frequency of the video low-pass filter. Lower values produce a softer image.

- **Video LPF HuC6270 5.36 MHz** [geargrafx_lowpass_speed_536] (**Disabled**|Enabled)

Apply the video low-pass filter when HuC6270 is running in 5.36 MHz dot clock mode (256px width).

- **Video LPF HuC6270 7.16 MHz** [geargrafx_lowpass_speed_716] (**Enabled**|Disabled)

Apply the video low-pass filter when HuC6270 is running in 7.16 MHz dot clock mode (341px width).

- **Video LPF HuC6270 10.8 MHz** [geargrafx_lowpass_speed_108] (**Enabled**|Disabled)

Apply the video low-pass filter when HuC6270 is running in 10.8 MHz dot clock mode (512px width).

- **Backup RAM (restart)** [geargrafx_backup_ram] (**Enabled**|Disabled)

Expand All @@ -184,6 +207,10 @@ Settings with (restart) means that core has to be closed for the new setting to

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.

- **Safe VDC Defaults (Homebrew)** [geargrafx_safe_vdc_defaults] (**Disabled**|Enabled)

When enabled, sets safe default values for the VDC (Video Display Controller) registers. This can help some homebrew software run correctly.

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

Select the CD-ROM system type. The *Auto* setting automatically selects the appropriate CD-ROM system based on the loaded content.
Expand All @@ -203,7 +230,7 @@ Settings with (restart) means that core has to be closed for the new setting to

- **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.
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)

Expand Down
12 changes: 10 additions & 2 deletions docs/library/gearlynx.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
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.
- 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 Down Expand Up @@ -52,7 +54,7 @@ Frontend-level settings or features that the Gearlynx core respects.
|-------------------|:---------:|
| Restart | ✔ |
| Screenshots | ✔ |
| Saves | |
| Saves | |
| States | ✔ |
| Rewind | ✔ |
| Netplay | ✔ |
Expand Down Expand Up @@ -81,6 +83,12 @@ The Gearlynx core's library name is 'Gearlynx'

The Gearlynx core saves/loads to/from these directories.

**Frontend's Save directory**

| File | Description |
|:-----:|:----------------------:|
| *.srm | EEPROM / NVRAM save |

**Frontend's State directory**

| File | Description |
Expand Down Expand Up @@ -112,7 +120,7 @@ Settings with (restart) means that core has to be closed for the new setting to
- *16:9 DAR* forces 16:9 aspect ratio.
- *16:10 DAR* forces 16:10 aspect ratio.

- **Screen Rotation** [gearlynx_rotation] (**Auto**|Left|Right)
- **Screen Rotation** [gearlynx_rotation] (**Auto**|Left|Right|Disabled)

Rotates the screen display. This is useful since many Lynx games were designed to be played with the system held vertically.

Expand Down
35 changes: 23 additions & 12 deletions docs/library/gearsystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@

Gearsystem is an open source, cross-platform, Sega Master System / Game Gear / SG-1000 / Othello Multivision emulator written in C++.

- Accurate Z80 core, including undocumented opcodes and behavior like R and MEMPTR registers.
- Supported cartridges: ROM, ROM + RAM, SEGA, Codemasters, Korean, MSX + Nemesis, Janggun, SG-1000, and many Korean multi-carts.
- Very accurate emulation supporting cartridges: ROM, ROM + RAM, SEGA, Codemasters, Korean, MSX + Nemesis, Janggun, SG-1000, and many Korean multi-carts.
- 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.
Expand Down Expand Up @@ -73,7 +72,7 @@ Frontend-level settings or features that the Gearsystem core respects.
| Core Options | ✔ |
| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✔ |
| RetroArch Cheats - Game Genie | ✔ |
| RetroArch Cheats - Pro Acion Replay | ✔ |
| RetroArch Cheats - Pro Action Replay | ✔ |
| Native Cheats | ✕ |
| Controls | ✔ |
| Remapping | ✔ |
Expand Down Expand Up @@ -124,14 +123,18 @@ The Gearsystem core has the following options that can be tweaked from the core

Settings with (restart) means that core has to be closed for the new setting to be applied on next launch.

- **System (restart)** [gearsystem_system] (**Auto**|Master System / Mark III|Game Gear|SG-1000 / Multivision)
- **System (restart)** [gearsystem_system] (**Auto**|Master System / Mark III|Game Gear (2 ASIC)|Game Gear (2 ASIC) SMS Mode|Game Gear (1 ASIC)|Game Gear (1 ASIC) SMS Mode|SG-1000 / Multivision|SG-1000 II)

Select which hardware/model is emulated.
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.
- *Master System / Mark III* forces original Master System / Mark III hardware.
- *Game Gear* forces Game Gear 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).
- *Game Gear (1 ASIC)* forces Game Gear hardware with 1 ASIC configuration.
- *Game Gear (1 ASIC) SMS Mode* forces Game Gear in SMS compatibility mode (1 ASIC).
- *SG-1000 / Multivision* forces SG-1000 / Multivision hardware.
- *SG-1000 II* forces SG-1000 II hardware.

- **Region (restart)** [gearsystem_region] (**Auto**|Master System Japan|Master System Export|Game Gear Japan|Game Gear Export|Game Gear International)

Expand All @@ -144,18 +147,18 @@ 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|MSX|Janggun|SG-1000)
- **Mapper (restart)** [gearsystem_mapper] (**Auto**|ROM|SEGA|Codemasters|Korean|SG-1000|MSX|Janggun|Korean 2000 XOR 1F|Korean MSX 32KB 2000|Korean MSX SMS 8000|Korean SMS 32KB 2000|Korean MSX 8KB 0300|Korean 0000 XOR FF|Korean FFFF HiCom|Korean FFFE|Korean BFFC|Korean FFF3 FFFC|Korean MD FFF5|Korean MD FFF0|Jumbo Dahjee|EEPROM 93C46|Multi 4PAK All Action|Iratahack)

Select which mapper (memory bank controller) is emulated.
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.
- *ROM* forces no mapper.
- *SEGA* forces SEGA mapper.
- *Codemasters* forces Codemasters mapper.
- *Korean* forces Korean mapper.
- *SG-1000* forces SG-1000 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 Expand Up @@ -193,19 +196,27 @@ Settings with (restart) means that core has to be closed for the new setting to

- **Master System BIOS (restart)** [gearsystem_bios_sms] (**Disabled**|Enabled)

This option will enables/disables BIOS for Master System / Mark III models. For this to work, the `bios.sms` file must exist in RetroArch's system directory.
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.

- **Game Gear BIOS (restart)** [gearsystem_bios_gg] (**Disabled**|Enabled)

This option will enables/disables BIOS for Game Gear model. For this to work, the `bios.gg` file must exist in the RetroArch's system directory.
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.

- **YM2413 (restart)** [gearsystem_ym2413] (**Auto**|Disabled)

This option will enables/disables YM2413 (OPLL) FM sound chip.
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.
- *Disabled* disables YM2413.

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

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)

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.

- **3D Glasses** [gearsystem_glasses] (**Both Eyes / OFF**|Left Eye|Right Eye)

For games with 3D glasses support this option will let you choose to display only left or right eye.
Expand Down
Loading