Skip to content

Commit 11de9b3

Browse files
drheliusdrhelius
committed
Update Geargrafx docs
1 parent c9400b4 commit 11de9b3

File tree

1 file changed

+55
-29
lines changed

1 file changed

+55
-29
lines changed

‎docs/library/geargrafx.md‎

Lines changed: 55 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@
44

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

7-
- Accurate emulation supporting the entire PCE / SGX catalog
7+
- Accurate emulation supporting the entire HuCard PCE / SGX catalog
8+
- CD-ROM² and Super CD-ROM² systems
89
- Multi Tap support (up to 5 players)
910
- Controllers:
10-
- Standard Gamepad (2 buttons)
11-
- Avenue Pad 3 (3 buttons, auto-configured based on game)
12-
- Avenue Pad 6 (6 buttons)
11+
* Standard Gamepad (2 buttons)
12+
* Avenue Pad 3 (3 buttons, auto-configured based on game)
13+
* Avenue Pad 6 (6 buttons)
1314
- Internal database for automatic rom detection
1415
- Backup RAM support
1516
- Save state support
@@ -30,7 +31,22 @@ A summary of the licenses behind RetroArch and its cores can be found [here](../
3031

3132
## BIOS
3233

33-
Geargrafx does not require BIOS (bootrom) files to work.
34+
Geargrafx requires a BIOS file to run CD-ROM games.
35+
36+
Required or optional firmware files go in RetroArch's system directory.
37+
38+
!!! attention
39+
Any CD-ROM System BIOS will work, but some of them are known to be incompatible with certain games.
40+
41+
!!! attention
42+
You can choose the BIOS to use in the core options menu.
43+
44+
| Filename | Description | md5sum |
45+
|:-------------:|:-------------------------------------:|:--------------------------------:|
46+
| syscard3.pce | Super CD-ROM2 System V3.xx - Required | 38179df8f4ac870017db21ebcbf53114 |
47+
| syscard2.pce | CD-ROM System V2.xx - Optional | |
48+
| syscard1.pce | CD-ROM System V1.xx - Optional | |
49+
| gexpress.pce | Game Express CD Card - Optional | |
3450

3551
## Extensions
3652

@@ -40,11 +56,13 @@ Content that can be loaded by the Geargrafx core have the following file extensi
4056
- .sgx
4157
- .bin
4258
- .rom
59+
- .cue
4360

4461
RetroArch database(s) that are associated with the Geargrafx core:
4562

4663
- [NEC - PC Engine - TurboGrafx 16](https://github.com/libretro/libretro-database/blob/master/rdb/NEC%20-%20PC%20Engine%20-%20TurboGrafx%2016.rdb)
4764
- [NEC - PC Engine SuperGrafx](https://github.com/libretro/libretro-database/blob/master/rdb/NEC%20-%20PC%20Engine%20SuperGrafx.rdb)
65+
- [NEC - PC Engine CD - TurboGrafx-CD](https://github.com/libretro/libretro-database/blob/master/rdb/NEC%20-%20PC%20Engine%20CD%20-%20TurboGrafx-CD.rdb)
4866

4967
## Features
5068

@@ -115,12 +133,13 @@ Settings with (restart) means that core has to be closed for the new setting to
115133

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

118-
- **Aspect Ratio** [geargrafx_aspect_ratio] (**1:1 PAR**|4:3 DAR|16:9 DAR|16:10 DAR)
136+
- **Aspect Ratio** [geargrafx_aspect_ratio] (**1:1 PAR**|4:3 DAR|6:5 DAR|16:9 DAR|16:10 DAR)
119137

120138
Select which aspect ratio will be presented by the core.
121139

122140
- *1:1 PAR* selects an aspect ratio that produces square pixels.
123141
- *4:3 DAR* forces 4:3 aspect ratio.
142+
- *6:5 DAR* forces 6:5 aspect ratio.
124143
- *16:9 DAR* forces 16:9 aspect ratio.
125144
- *16:10 DAR* forces 16:10 aspect ratio.
126145

@@ -154,22 +173,29 @@ Settings with (restart) means that core has to be closed for the new setting to
154173

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

157-
- **Force Japanese PC Engine (restart)** [geargrafx_force_pce_jap] (**Disabled**|Enabled)
176+
- **System (restart)** [geargrafx_console_type] (**Auto**|PC Engine (JAP)|SuperGrafx (JAP)|TurboGrafx-16 (USA))
158177

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.
178+
Select the console type to emulate. The default setting, Auto, automatically detects the appropriate console type based on the loaded content.
179+
Many US games will not start if a Japanese system is detected.
161180

162-
- **Force SuperGrafx (restart)** [geargrafx_force_sgx] (**Disabled**|Enabled)
181+
- **CD-ROM (restart)** [geargrafx_cdrom_type] (**Auto**|Standard|Super CD-ROM|Arcade CD-ROM)
163182

164-
Allows you to force SuperGrafx hardware.
165-
This option is recommended only for content (homebrew) not detected correctly as SuperGrafx.
183+
Choose the type of CD-ROM system to emulate. The Auto setting automatically selects the appropriate CD-ROM type based on the loaded content.
184+
185+
- **CD-ROM Bios (restart)** [geargrafx_cdrom_bios] (**Auto**|System Card 1|System Card 2|System Card 3|Game Express)
186+
187+
Specify the BIOS file to use for CD-ROM emulation. The *Auto* setting automatically selects the appropriate BIOS based on the loaded content. You can also manually choose one for compatibility with specific games.
166188

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

169-
Enabling this option will remove the sprite limit in a single line.
170-
This may cause glitches to occur in certain games.
191+
Enabling this option removes the per-line sprite limit, but may cause glitches in certain games.
171192
It's best to keep this core option disabled.
172193

194+
- **Avenue Pad 3 Switch** [geargrafx_avenue_pad_3_switch] (**Auto**|SELECT|RUN)
195+
196+
When using the Avenue Pad 3 controller, you can set the switch to either *RUN* or *SELECT* with this option.
197+
If you choose *Auto*, the emulator will select the best option based on the game being played.
198+
173199
- **Soft Reset** [geargrafx_soft_reset] (**Enabled**|Disabled)
174200

175201
Pressing RUN and SELECT simultaneously on the PCE gamepad will SOFT RESET the console. This is the default hardware behavior.
@@ -183,24 +209,24 @@ Settings with (restart) means that core has to be closed for the new setting to
183209

184210
## Joypad
185211

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 |
212+
| RetroPad Inputs | PCE Pad (2-button) | Avenue Pad 3 (3-button) | Avenue Pad 6 (6-button) |
213+
|---------------------------------------------|--------------------|----------------------------|-------------------------|
214+
| ![](../image/retropad/retro_dpad_up.png) | D-Pad Up | D-Pad Up | D-Pad Up |
215+
| ![](../image/retropad/retro_dpad_down.png) | D-Pad Down | D-Pad Down | D-Pad Down |
216+
| ![](../image/retropad/retro_dpad_left.png) | D-Pad Left | D-Pad Left | D-Pad Left |
217+
| ![](../image/retropad/retro_dpad_right.png) | D-Pad Right | D-Pad Right | D-Pad Right |
218+
| ![](../image/retropad/retro_select.png) | Select | Select | Select |
219+
| ![](../image/retropad/retro_start.png) | Run | Run | Run |
220+
| ![](../image/retropad/retro_a.png) | I | I | I |
221+
| ![](../image/retropad/retro_b.png) | II | II | II |
222+
| ![](../image/retropad/retro_y.png) | | III (mapped to Select/Run) | III |
223+
| ![](../image/retropad/retro_x.png) | | | IV |
224+
| ![](../image/retropad/retro_l2.png) | | | V |
225+
| ![](../image/retropad/retro_r2.png) | | | VI |
200226

201227
## External Links
202228

203229
- [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)
230+
- [Libretro Geargrafx Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/geargrafx_libretro.info)
205231
- [Report Libretro Geargrafx Core Issues Here](https://github.com/drhelius/Geargrafx/issues)
206232

0 commit comments

Comments
 (0)