Skip to content

Commit dc2a785

Browse files
committed
Update Geargrafx docs
1 parent a14af3f commit dc2a785

File tree

1 file changed

+110
-31
lines changed

1 file changed

+110
-31
lines changed

docs/library/geargrafx.md

Lines changed: 110 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Geargrafx requires a BIOS file to run CD-ROM games.
3636
Required or optional firmware files go in RetroArch's system directory.
3737

3838
!!! attention
39-
Any CD-ROM System BIOS will work, but some of them are known to be incompatible with certain games.
39+
Any CD-ROM System BIOS will work, but some are known to be incompatible with certain games.
4040

4141
!!! attention
4242
You can choose the BIOS to use in the core options menu.
@@ -130,9 +130,10 @@ The Geargrafx core has the following options that can be tweaked from the core o
130130

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

133-
- **TurboTap** [geargrafx_turbotap] (**Disabled**|Enabled)
133+
- **System (restart)** [geargrafx_console_type] (**Auto**|PC Engine (JAP)|SuperGrafx (JAP)|TurboGrafx-16 (USA))
134134

135-
This option enables/disables TurboTap support (up to 5 players).
135+
Select the console type to emulate. The default setting, Auto, automatically detects the appropriate console type based on the loaded content.
136+
Many US games will not start if a Japanese system is detected.
136137

137138
- **Aspect Ratio** [geargrafx_aspect_ratio] (**1:1 PAR**|4:3 DAR|6:5 DAR|16:9 DAR|16:10 DAR)
138139

@@ -156,12 +157,12 @@ Settings with (restart) means that core has to be closed for the new setting to
156157
- *240p* forces 240 scanlines.
157158
- *Manual* lets you set the first and last scanline manually.
158159

159-
- **Scanline Start (Manual)** [geargrafx_scanline_start] (**3**|0 - 30)
160+
- **Scanline Start (Manual)** [geargrafx_scanline_start] (**3**|values from 0 to 30)
160161

161162
This option will set the first scanline to be displayed. Scanline 0 is the first visible scanline.
162163
This option is only available when 'Scanline Count' is set to 'Manual'.
163164

164-
- **Scanline End (Manual)** [geargrafx_scanline_end] (**241**|220 - 241)
165+
- **Scanline End (Manual)** [geargrafx_scanline_end] (**241**|values from 220 to 241)
165166

166167
This option will set the last scanline to be displayed. Scanline 241 is the last visible scanline.
167168
This option is only available when 'Scanline Count' is set to 'Manual'.
@@ -170,14 +171,14 @@ Settings with (restart) means that core has to be closed for the new setting to
170171

171172
If enabled, the core will use composite colors instead of RGB colors.
172173

173-
- **Backup RAM (restart)** [geargrafx_backup_ram] (**Enabled**|Disabled)
174+
- **No Sprite Limit** [geargrafx_no_sprite_limit] (**Disabled**|Enabled)
174175

175-
This option allows you to disable backup RAM (not recommended).
176+
Enabling this option removes the per-line sprite limit, but may cause glitches in certain games.
177+
It's best to keep this core option disabled.
176178

177-
- **System (restart)** [geargrafx_console_type] (**Auto**|PC Engine (JAP)|SuperGrafx (JAP)|TurboGrafx-16 (USA))
179+
- **Backup RAM (restart)** [geargrafx_backup_ram] (**Enabled**|Disabled)
178180

179-
Select the console type to emulate. The default setting, Auto, automatically detects the appropriate console type based on the loaded content.
180-
Many US games will not start if a Japanese system is detected.
181+
This option allows you to disable backup RAM (not recommended).
181182

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

@@ -191,41 +192,120 @@ Settings with (restart) means that core has to be closed for the new setting to
191192

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

194-
- **No Sprite Limit** [geargrafx_no_sprite_limit] (**Disabled**|Enabled)
195+
- **PSG Volume** [geargrafx_psg_volume] (**100**|0 - 200)
195196

196-
Enabling this option removes the per-line sprite limit, but may cause glitches in certain games.
197-
It's best to keep this core option disabled.
197+
This option sets the volume of the PSG sound system, which is used for sound effects and music in many games.
198+
The value is a percentage from 0 to 200, where 100 is the default volume.
198199

199-
- **Avenue Pad 3 Switch** [geargrafx_avenue_pad_3_switch] (**Auto**|SELECT|RUN)
200+
- **CD-ROM Volume** [geargrafx_cdrom_volume] (**100**|0 - 200)
200201

201-
When using the Avenue Pad 3 controller, you can set the switch to either *RUN* or *SELECT* with this option.
202-
If you choose *Auto*, the emulator will select the best option based on the game being played.
202+
This option sets the volume of the CD-ROM sound system, which is used for music in CD-ROM games.
203+
The value is a percentage from 0 to 200, where 100 is the default volume.
203204

204-
- **Soft Reset** [geargrafx_soft_reset] (**Enabled**|Disabled)
205+
- **ADPCM Volume** [geargrafx_adpcm_volume] (**100**|0 - 200)
205206

206-
Pressing RUN and SELECT simultaneously on the PCE gamepad will SOFT RESET the console. This is the default hardware behavior.
207-
Disable this option if you want the soft reset functionality turned off.
207+
This option sets the volume of the ADPCM sound system, which is typically used for speech in CD-ROM games.
208+
The value is a percentage from 0 to 200, where 100 is the default volume.
208209

209210
- **Allow Up+Down / Left+Right** [geargrafx_up_down_allowed] (**Disabled**|Enabled)
210211

211212
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.
212213
This may cause movement based glitches to occur in certain games.
213214
It's best to keep this core option disabled.
214215

215-
- **PSG Volume** [geargrafx_psg_volume] (**100**|0 - 200)
216+
- **Allow Soft Reset** [geargrafx_soft_reset] (**Enabled**|Disabled)
216217

217-
This option sets the volume of the PSG sound system, which is used for sound effects and music in many games.
218-
The value is a percentage from 0 to 200, where 100 is the default volume.
218+
Pressing RUN and SELECT simultaneously on the PCE gamepad will SOFT RESET the console. This is the default hardware behavior.
219+
Disable this option if you want the soft reset functionality turned off.
219220

220-
- **CD-ROM Volume** [geargrafx_cdrom_volume] (**100**|0 - 200)
221+
- **TurboTap** [geargrafx_turbotap] (**Disabled**|Enabled)
221222

222-
This option sets the volume of the CD-ROM sound system, which is used for music in CD-ROM games.
223-
The value is a percentage from 0 to 200, where 100 is the default volume.
223+
This option enables/disables TurboTap support (up to 5 players).
224224

225-
- **ADPCM Volume** [geargrafx_adpcm_volume] (**100**|0 - 200)
225+
- **Avenue Pad 3 Switch** [geargrafx_avenue_pad_3_switch] (**Auto**|SELECT|RUN)
226226

227-
This option sets the volume of the ADPCM sound system, which is typically used for speech in CD-ROM games.
228-
The value is a percentage from 0 to 200, where 100 is the default volume.
227+
When using the Avenue Pad 3 controller, you can set the switch to either *RUN* or *SELECT* with this option.
228+
If you choose *Auto*, the emulator will select the best option based on the game being played.
229+
230+
- **P1 Turbo I** [geargrafx_turbo_p1_i] (**Disabled**|Enabled)
231+
232+
Enables/disables the Turbo I button for Player 1.
233+
234+
- **P1 Turbo II** [geargrafx_turbo_p1_ii] (**Disabled**|Enabled)
235+
236+
Enables/disables the Turbo II button for Player 1.
237+
238+
- **P2 Turbo I** [geargrafx_turbo_p2_i] (**Disabled**|Enabled)
239+
240+
Enables/disables the Turbo I button for Player 2.
241+
242+
- **P2 Turbo II** [geargrafx_turbo_p2_ii] (**Disabled**|Enabled)
243+
244+
Enables/disables the Turbo II button for Player 2.
245+
246+
- **P3 Turbo I** [geargrafx_turbo_p3_i] (**Disabled**|Enabled)
247+
248+
Enables/disables the Turbo I button for Player 3.
249+
250+
- **P3 Turbo II** [geargrafx_turbo_p3_ii] (**Disabled**|Enabled)
251+
252+
Enables/disables the Turbo II button for Player 3.
253+
254+
- **P4 Turbo I** [geargrafx_turbo_p4_i] (**Disabled**|Enabled)
255+
256+
Enables/disables the Turbo I button for Player 4.
257+
258+
- **P4 Turbo II** [geargrafx_turbo_p4_ii] (**Disabled**|Enabled)
259+
260+
Enables/disables the Turbo II button for Player 4.
261+
262+
- **P5 Turbo I** [geargrafx_turbo_p5_i] (**Disabled**|Enabled)
263+
264+
Enables/disables the Turbo I button for Player 5.
265+
266+
- **P5 Turbo II** [geargrafx_turbo_p5_ii] (**Disabled**|Enabled)
267+
268+
Enables/disables the Turbo II button for Player 5.
269+
270+
- **P1 Turbo I Speed** [geargrafx_turbo_speed_p1_i] (**4**|values from 1 to 15)
271+
272+
Number of frames between each button I toggle for Player 1.
273+
274+
- **P1 Turbo II Speed** [geargrafx_turbo_speed_p1_ii] (**4**|values from 1 to 15)
275+
276+
Number of frames between each button II toggle for Player 1.
277+
278+
- **P2 Turbo I Speed** [geargrafx_turbo_speed_p2_i] (**4**|values from 1 to 15)
279+
280+
Number of frames between each button I toggle for Player 2.
281+
282+
- **P2 Turbo II Speed** [geargrafx_turbo_speed_p2_ii] (**4**|values from 1 to 15)
283+
284+
Number of frames between each button II toggle for Player 2.
285+
286+
- **P3 Turbo I Speed** [geargrafx_turbo_speed_p3_i] (**4**|values from 1 to 15)
287+
288+
Number of frames between each button I toggle for Player 3.
289+
290+
- **P3 Turbo II Speed** [geargrafx_turbo_speed_p3_ii] (**4**|values from 1 to 15)
291+
292+
Number of frames between each button II toggle for Player 3.
293+
294+
- **P4 Turbo I Speed** [geargrafx_turbo_speed_p4_i] (**4**|values from 1 to 15)
295+
296+
Number of frames between each button I toggle for Player 4.
297+
298+
- **P4 Turbo II Speed** [geargrafx_turbo_speed_p4_ii] (**4**|values from 1 to 15)
299+
300+
Number of frames between each button II toggle for Player 4.
301+
302+
- **P5 Turbo I Speed** [geargrafx_turbo_speed_p5_i] (**4**|values from 1 to 15)
303+
304+
Number of frames between each button I toggle for Player 5.
305+
306+
- **P5 Turbo II Speed** [geargrafx_turbo_speed_p5_ii] (**4**|values from 1 to 15)
307+
308+
Number of frames between each button II toggle for Player 5.
229309

230310
## Joypad
231311

@@ -241,12 +321,11 @@ Settings with (restart) means that core has to be closed for the new setting to
241321
| ![](../image/retropad/retro_b.png) | II | II | II |
242322
| ![](../image/retropad/retro_y.png) | | III (mapped to Select/Run) | III |
243323
| ![](../image/retropad/retro_x.png) | | | IV |
244-
| ![](../image/retropad/retro_l2.png) | | | V |
245-
| ![](../image/retropad/retro_r2.png) | | | VI |
324+
| ![](../image/retropad/retro_l2.png) | Toggle Turbo II | Toggle Turbo II | V |
325+
| ![](../image/retropad/retro_r2.png) | Toggle Turbo I | Toggle Turbo I | VI |
246326

247327
## External Links
248328

249329
- [Official Geargrafx Repository](https://github.com/drhelius/Geargrafx)
250330
- [Libretro Geargrafx Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/geargrafx_libretro.info)
251331
- [Report Libretro Geargrafx Core Issues Here](https://github.com/drhelius/Geargrafx/issues)
252-

0 commit comments

Comments
 (0)