Skip to content

Commit 3fe8994

Browse files
LibretroAdminLibretroAdmin
authored
Merge pull request #1049 from drhelius/master
Update 'gear' cores and add Geargrafx
2 parents 8539aca + c9400b4 commit 3fe8994

File tree

10 files changed

+242
-25
lines changed

10 files changed

+242
-25
lines changed

‎docs/development/licenses.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ See below for a summary of the licenses behind RetroArch and its cores:
125125
| [Game Music Emu](../library/game_music_emu.md) | [GPLv3](https://github.com/libretro/libretro-gme/blob/master/LICENSE) | |
126126
| [Gearboy](../library/gearboy.md) | [GPLv3](https://github.com/drhelius/Gearboy/blob/master/LICENSE) | |
127127
| [Gearcoleco](../library/gearcoleco.md) | [GPLv3](https://github.com/drhelius/Gearcoleco/blob/master/LICENSE) | |
128+
| [Geargrafx](../library/geargrafx.md) | [GPLv3](https://github.com/drhelius/Geargrafx/blob/master/LICENSE) | |
128129
| [Gearsystem](../library/gearsystem.md) | [GPLv3](https://github.com/drhelius/Gearsystem/blob/master/LICENSE) | |
129130
| [Genesis Plus GX](../library/genesis_plus_gx.md) | [Non-commercial](https://github.com/libretro/Genesis-Plus-GX/blob/master/LICENSE.txt) | Non-commercial |
130131
| [Geolith](../library/geolith.md) | [BSD-3-Clause, MIT](https://github.com/libretro/geolith-libretro/blob/master/LICENSE) | |

‎docs/guides/core-list.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,8 @@
9797
| Game Music Emu | Music player | A port of Game Music Emu which allows playback of a wide variety of video game music formats |
9898
| [Gearboy](../library/gearboy.md) | Game Boy/Color | |
9999
| [Gearcoleco](../library/gearcoleco.md) | Coleco ColecoVision | |
100-
| Gearsystem | Sega MS/GG/SG-1000 | |
100+
| [Geargrafx](../library/geargrafx.md) | NEC PC Engine/SuperGrafx | |
101+
| [Gearsystem](../library/gearsystem.md) | Sega MS/GG/SG-1000 | |
101102
| Genesis Plus GX | Sega MS/GG/MD/CD | |
102103
| Geolith | SNK Neo Geo AES/MVS | Highly accurate emulator for the Neo Geo AES and MVS Cartridge Systems |
103104
| [gpSP](../library/gpsp.md) | Game Boy Advance | |

‎docs/guides/retroachievements.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ You can also check the progress of your friends and add comments on their trophi
116116
| [SMS Plus GX](https://github.com/libretro/smsplus-gx) | ✕ | |
117117
| [blueMSX](https://github.com/libretro/blueMSX-libretro) | ✔ | |
118118
| [FinalBurn Neo](https://github.com/libretro/FBNeo) | ✕ | |
119-
| [Gearcoleco](https://github.com/drhelius/Gearcoleco) | ✕ | |
119+
| [Gearcoleco](https://github.com/drhelius/Gearcoleco) | ✔ | |
120120

121121
### GCE
122122

@@ -161,6 +161,7 @@ You can also check the progress of your friends and add comments on their trophi
161161
| [Beetle PCE FAST](https://github.com/libretro/beetle-pce-fast-libretro) | ✔ | Highest speed. Does not support SuperGrafx games. |
162162
| [Beetle SuperGrafx](https://github.com/libretro/beetle-supergrafx-libretro) | ✔ | High speed. Supports SuperGrafx games. |
163163
| [Beetle PCE](https://github.com/libretro/beetle-pce-libretro) | ✕ | |
164+
| [Geargrafx](https://github.com/drhelius/Geargrafx) | ✔ | |
164165
| [FinalBurn Neo](https://github.com/libretro/FBNeo) | ✕ | |
165166

166167
#### PC-FX

‎docs/guides/softpatching.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ rom.ips2
2727
|--------------------------------------------|:---------:|
2828
| [Gearcoleco](../library/gearcoleco.md) | ✔ |
2929

30+
### NEC PC Engine - TurboGrafx-16 / PC Engine CD - TurboGrafx-CD
31+
32+
| Core | Supported |
33+
|--------------------------------------------|:---------:|
34+
| [Geargrafx](../library/geargrafx.md) | ✔ |
35+
3036
### Nintendo - DS
3137

3238
| Core | Supported |

‎docs/library/gearboy.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,21 +121,21 @@ The Gearboy core saves/loads to/from these directories.
121121

122122
The Gearboy core has the following options that can be tweaked from the core options menu. The default setting is bolded.
123123

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

126126
- **Game Boy Model (restart)** [gearboy_model] (**Auto**|Game Boy DMG|Game Boy Advance)
127127

128128
Select which hardware/model is emulated.
129129

130-
- *Auto* selects the best hardware based in the rom.
130+
- *Auto* selects the best hardware based on the rom.
131131
- *Game Boy DMG* forces original Game Boy hardware.
132132
- *Game Boy Advance* enables Game Boy Advance hardware.
133133

134134
- **Mapper (restart)** [gearboy_mapper] (**Auto**|ROM Only|MBC 1|MBC 2|MBC 3|MBC 5|MBC 1 Multicart)
135135

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

138-
- *Auto* selects the best MBC based in the rom.
138+
- *Auto* selects the best MBC based on the rom.
139139
- *ROM Only* forces no MBC.
140140
- *MBC 1* forces MBC 1.
141141
- *MBC 2* forces MBC 2.
@@ -149,15 +149,15 @@ Settings with (Restart) means that core has to be closed for the new setting to
149149

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

152-
This option will enable/disable bootrom for Game Boy DMG model. For this to work, the `dmg_boot.bin` file must exist in the Retro Arch's system directory.
152+
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.
153153

154154
- **Game Boy Color Bootrom** [gearboy_bootrom_gbc] (**Disabled**|Enabled)
155155

156-
This option will enable/disable bootrom for Game Boy Color model. For this to work, the `cgb_boot.bin` file must exist in the Retro Arch's system directory.
156+
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.
157157

158158
- **Allow Up+Down / Left+Right** [gearboy_up_down_allowed] (**Disabled**|Enabled)
159159

160-
Enabling this will allow pressing / quickly alternating / holding both left and right (or up and down in some games) directions at the same time.
160+
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.
161161

162162
This may cause movement based glitches to occur in certain games.
163163

‎docs/library/gearcoleco.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ A summary of the licenses behind RetroArch and its cores can be found [here](../
2222

2323
## BIOS
2424

25-
Gearcoleco require a BIOS file to work.
25+
Gearcoleco requires a BIOS file to work.
2626

2727
Required or optional firmware files go in the frontend's system directory.
2828

@@ -107,13 +107,13 @@ The Gearcoleco core saves/loads to/from these directories.
107107

108108
The Gearcoleco core has the following options that can be tweaked from the core options menu. The default setting is bolded.
109109

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

112112
- **Refresh Rate (restart)** [gearcoleco_timing] (**Auto**|NTSC (60 Hz)|PAL (50 Hz))
113113

114114
Select which refresh rate will be used in emulation.
115115

116-
- *Auto* selects the best refresh rate based in the rom.
116+
- *Auto* selects the best refresh rate based on the rom.
117117
- *NTSC (60 Hz)* forces 60 Hz.
118118
- *PAL (50 Hz)* forces 50 Hz.
119119

@@ -137,7 +137,7 @@ Settings with (Restart) means that core has to be closed for the new setting to
137137

138138
- **Allow Up+Down / Left+Right** [gearcoleco_up_down_allowed] (**Disabled**|Enabled)
139139

140-
Enabling this will allow pressing / quickly alternating / holding both left and right (or up and down in some games) directions at the same time.
140+
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.
141141

142142
This may cause movement based glitches to occur in certain games.
143143

‎docs/library/geargrafx.md

Lines changed: 206 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
1+
# NEC - PC Engine / SuperGrafx (Geargrafx)
2+
3+
## Background
4+
5+
Geargrafx is an open source, cross-platform, PC Engine / TurboGrafx-16 / SuperGrafx emulator written in C++.
6+
7+
- Accurate emulation supporting the entire PCE / SGX catalog
8+
- Multi Tap support (up to 5 players)
9+
- Controllers:
10+
- Standard Gamepad (2 buttons)
11+
- Avenue Pad 3 (3 buttons, auto-configured based on game)
12+
- Avenue Pad 6 (6 buttons)
13+
- Internal database for automatic rom detection
14+
- Backup RAM support
15+
- Save state support
16+
- Retro Achievements support
17+
- Adjustable scanline count (224p, 240p, or manual)
18+
- RGB or Composite color output
19+
- 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.
20+
21+
The Geargrafx core has been authored by
22+
23+
- [Ignacio Sanchez (drhelius)](https://github.com/drhelius)
24+
25+
The Geargrafx core is licensed under
26+
27+
- [GPLv3](https://github.com/drhelius/Geargrafx/blob/master/LICENSE)
28+
29+
A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md).
30+
31+
## BIOS
32+
33+
Geargrafx does not require BIOS (bootrom) files to work.
34+
35+
## Extensions
36+
37+
Content that can be loaded by the Geargrafx core have the following file extensions:
38+
39+
- .pce
40+
- .sgx
41+
- .bin
42+
- .rom
43+
44+
RetroArch database(s) that are associated with the Geargrafx core:
45+
46+
- [NEC - PC Engine - TurboGrafx 16](https://github.com/libretro/libretro-database/blob/master/rdb/NEC%20-%20PC%20Engine%20-%20TurboGrafx%2016.rdb)
47+
- [NEC - PC Engine SuperGrafx](https://github.com/libretro/libretro-database/blob/master/rdb/NEC%20-%20PC%20Engine%20SuperGrafx.rdb)
48+
49+
## Features
50+
51+
Frontend-level settings or features that the Geargrafx core respects.
52+
53+
| Feature | Supported |
54+
|-------------------|:---------:|
55+
| Restart | ✔ |
56+
| Screenshots | ✔ |
57+
| Saves | ✔ |
58+
| States | ✔ |
59+
| Rewind | ✔ |
60+
| Netplay | ✕ |
61+
| Core Options | ✔ |
62+
| RetroAchievements | ✔ |
63+
| RetroArch Cheats | ✔ |
64+
| Native Cheats | ✕ |
65+
| Controls | ✔ |
66+
| Remapping | ✔ |
67+
| Multi-Mouse | ✕ |
68+
| Rumble | ✕ |
69+
| Sensors | ✕ |
70+
| Camera | ✕ |
71+
| Location | ✕ |
72+
| Subsystem | ✕ |
73+
| [Softpatching](../guides/softpatching.md) | ✔ |
74+
| Disk Control | ✕ |
75+
| Username | ✕ |
76+
| Language | ✕ |
77+
| Crop Overscan | ✔ |
78+
| LEDs | ✕ |
79+
80+
## Directories
81+
82+
The Geargrafx core's library name is 'Geargrafx'
83+
84+
The Geargrafx core saves/loads to/from these directories.
85+
86+
**Frontend's Save directory**
87+
88+
| File | Description |
89+
|:-----:|:----------------------:|
90+
| *.srm | Cartridge battery save |
91+
92+
**Frontend's State directory**
93+
94+
| File | Description |
95+
|:--------:|:-----------:|
96+
| *.state# | State |
97+
98+
## Geometry and timing
99+
100+
- The Geargrafx core's provided FPS is 59.82
101+
- The Geargrafx core's provided sample rate is 44100 Hz
102+
- The Geargrafx core's base width is dependent on the content and overscan settings (Without overscan: 256, 341, 512. With overscan: 280, 373, 560)
103+
- The Geargrafx core's base height is dependent on the ['Scanline Start' and 'Scanline End' core options](#core-options).
104+
- The Geargrafx core's max width is 560
105+
- The Geargrafx core's max height is 242
106+
- The Geargrafx core's provided aspect ratio is dependent on the ['Aspect Ratio' core option](#core-options).
107+
108+
## Core options
109+
110+
The Geargrafx core has the following options that can be tweaked from the core options menu. The default setting is bolded.
111+
112+
Settings with (restart) means that core has to be closed for the new setting to be applied on next launch.
113+
114+
- **TurboTap** [geargrafx_turbotap] (**Disabled**|Enabled)
115+
116+
This option enables/disables TurboTap support (up to 5 players).
117+
118+
- **Aspect Ratio** [geargrafx_aspect_ratio] (**1:1 PAR**|4:3 DAR|16:9 DAR|16:10 DAR)
119+
120+
Select which aspect ratio will be presented by the core.
121+
122+
- *1:1 PAR* selects an aspect ratio that produces square pixels.
123+
- *4:3 DAR* forces 4:3 aspect ratio.
124+
- *16:9 DAR* forces 16:9 aspect ratio.
125+
- *16:10 DAR* forces 16:10 aspect ratio.
126+
127+
- **Overscan** [geargrafx_overscan] (**Disabled**|Enabled)
128+
129+
This option enables/disables overscan (borders). Overscan width is dependent on the content.
130+
131+
- **Scanline Count** [geargrafx_scanline_count] (**224p**|240p|Manual)
132+
133+
Select which scanline count will be used in emulation.
134+
135+
- *224p* forces 224 scanlines.
136+
- *240p* forces 240 scanlines.
137+
- *Manual* lets you set the first and last scanline manually.
138+
139+
- **Scanline Start (Manual)** [geargrafx_scanline_start] (**3**|0 - 30)
140+
141+
This option will set the first scanline to be displayed. Scanline 0 is the first visible scanline.
142+
This option is only available when 'Scanline Count' is set to 'Manual'.
143+
144+
- **Scanline End (Manual)** [geargrafx_scanline_end] (**241**|220 - 241)
145+
146+
This option will set the last scanline to be displayed. Scanline 241 is the last visible scanline.
147+
This option is only available when 'Scanline Count' is set to 'Manual'.
148+
149+
- **Composite Colors** [geargrafx_composite_colors] (**Disabled**|Enabled)
150+
151+
If enabled, the core will use composite colors instead of RGB colors.
152+
153+
- **Backup RAM (restart)** [geargrafx_backup_ram] (**Enabled**|Disabled)
154+
155+
This option allows you to disable backup RAM (not recommended).
156+
157+
- **Force Japanese PC Engine (restart)** [geargrafx_force_pce_jap] (**Disabled**|Enabled)
158+
159+
Allows you to force Japanese PC Engine hardware.
160+
This option is not recommended, as many USA games will fail to start if a Japanese system is detected.
161+
162+
- **Force SuperGrafx (restart)** [geargrafx_force_sgx] (**Disabled**|Enabled)
163+
164+
Allows you to force SuperGrafx hardware.
165+
This option is recommended only for content (homebrew) not detected correctly as SuperGrafx.
166+
167+
- **No Sprite Limit** [geargrafx_no_sprite_limit] (**Disabled**|Enabled)
168+
169+
Enabling this option will remove the sprite limit in a single line.
170+
This may cause glitches to occur in certain games.
171+
It's best to keep this core option disabled.
172+
173+
- **Soft Reset** [geargrafx_soft_reset] (**Enabled**|Disabled)
174+
175+
Pressing RUN and SELECT simultaneously on the PCE gamepad will SOFT RESET the console. This is the default hardware behavior.
176+
Disable this option if you want the soft reset functionality turned off.
177+
178+
- **Allow Up+Down / Left+Right** [geargrafx_up_down_allowed] (**Disabled**|Enabled)
179+
180+
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.
181+
This may cause movement based glitches to occur in certain games.
182+
It's best to keep this core option disabled.
183+
184+
## Joypad
185+
186+
| RetroPad Inputs | PCE Pad (2-button) | Avenue Pad 3 (3-button) | Avenue Pad 6 (6-button) |
187+
|----------------------------------------------|--------------------|-------------------------|-------------------------|
188+
| ![](../image/retropad/retro_dpad_up.png) | D-Pad Up | D-Pad Up | D-Pad Up |
189+
| ![](../image/retropad/retro_dpad_down.png) | D-Pad Down | D-Pad Down | D-Pad Down |
190+
| ![](../image/retropad/retro_dpad_left.png) | D-Pad Left | D-Pad Left | D-Pad Left |
191+
| ![](../image/retropad/retro_dpad_right.png) | D-Pad Right | D-Pad Right | D-Pad Right |
192+
| ![](../image/retropad/retro_select.png) | Select | Select | Select |
193+
| ![](../image/retropad/retro_start.png) | Run | Run | Run |
194+
| ![](../image/retropad/retro_a.png) | I | I | I |
195+
| ![](../image/retropad/retro_b.png) | II | II | II |
196+
| ![](../image/retropad/retro_y.png) | III | III | III |
197+
| ![](../image/retropad/retro_x.png) | IV | | IV |
198+
| ![](../image/retropad/retro_l2.png) | V | | V |
199+
| ![](../image/retropad/retro_r2.png) | VI | | VI |
200+
201+
## External Links
202+
203+
- [Official Geargrafx Repository](https://github.com/drhelius/Geargrafx)
204+
- [Libretro Geargrafx Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/Geargrafx_libretro.info)
205+
- [Report Libretro Geargrafx Core Issues Here](https://github.com/drhelius/Geargrafx/issues)
206+

0 commit comments

Comments
 (0)