Skip to content

Commit f605712

Browse files
drheliusdrhelius
authored
Update "gear" emulator docs (#1014)
* Update Gearboy docs * Update Gearcoleco docs * Update Gearsystem docs
1 parent 3e39276 commit f605712

File tree

3 files changed

+74
-26
lines changed

3 files changed

+74
-26
lines changed

‎docs/library/gearboy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Gearboy is an open source, cross-platform, Nintendo Game Boy (DMG) / Game Boy Co
1313
- Save states.
1414
- Game Genie and GameShark cheat support.
1515
- Bootrom (BIOS) support.
16-
- 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, ...) and QNX.
16+
- 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.
1717

1818
The Gearboy core has been authored by:
1919

‎docs/library/gearcoleco.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Gearcoleco is an open source, cross-platform, ColecoVision emulator written in C
88
- Accurate TMS9918 emulation.
99
- Support for ColecoVision Super Game Module (SGM) and MegaCart ROMs.
1010
- Support for Super Action Controller (SAC), Wheel Controller and Roller Controller.
11-
- 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 and QNX.
11+
- 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.
1212

1313
The Gearcoleco core has been authored by
1414

@@ -117,21 +117,23 @@ Settings with (Restart) means that core has to be closed for the new setting to
117117
- *NTSC (60 Hz)* forces 60 Hz.
118118
- *PAL (50 Hz)* forces 50 Hz.
119119

120-
- **Aspect Ratio (restart)** [gearcoleco_aspect_ratio] (**Auto**|4:3|16:9)
120+
- **Aspect Ratio** [gearcoleco_aspect_ratio] (**Auto**|4:3|16:9)
121121

122122
Select which aspect ratio will be presented by the core.
123123

124124
- *1:1 PAR* selects an aspect ratio that produces square pixels.
125-
- *4:3 PAR* forces 4:3 aspect ratio.
126-
- *16:9 PAR* forces 16:9 aspect ratio.
125+
- *4:3 DAR* forces 4:3 aspect ratio.
126+
- *16:9 DAR* forces 16:9 aspect ratio.
127+
- *16:10 DAR* forces 16:10 aspect ratio.
127128

128129
- **Overscan** [gearcoleco_overscan] (**Disabled**|Top+Bottom|Full)
129-
130+
130131
Select which overscan (borders) will be used in emulation.
131132

132133
- *Disabled* disables overscan.
133134
- *Top+Bottom* enables overscan for top and bottom.
134-
- *Full* enables overscan for top, bottom, left and right.
135+
- *Full (284 width)* enables overscan for top, bottom, left and right (284 width).
136+
- *Full (320 width)* enables overscan for top, bottom, left and right (320 width).
135137

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

@@ -158,7 +160,7 @@ Settings with (Restart) means that core has to be closed for the new setting to
158160
- *Wheel Controller* enables spinner support for Wheel Controller.
159161
- *Roller Controller* enables spinner support for Roller Controller.
160162

161-
- **Spinner Sensitivity** [gearcoleco_spinner_sensitivity] (**1**|2|3|4|5|6|7|8|9|10)
163+
- **Spinner Sensitivity** [gearcoleco_spinner_sensitivity] (**1**|1-10)
162164

163165
Select the spinner sensitivity.
164166

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

168170
### Joypad
169171

170-
| User 1 and User 2 input descriptors | RetroPad Inputs |
172+
| Coleco Controller | RetroPad Inputs |
171173
|-------------------------------------|------------------------------------------------|
172174
| Joystick Up | ![](../image/retropad/retro_dpad_up.png) |
173175
| Joystick Down | ![](../image/retropad/retro_dpad_down.png) |

‎docs/library/gearsystem.md

Lines changed: 63 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,16 @@
55
Gearsystem is an open source, cross-platform, Sega Master System / Game Gear / SG-1000 / Othello Multivision emulator written in C++.
66

77
- Accurate Z80 core, including undocumented opcodes and behavior like R and MEMPTR registers.
8-
- Supported cartridges: ROM, ROM + RAM, SEGA, Codemasters, Korean, MSX + Nemesis, Janggun, SG-1000.
8+
- Supported cartridges: ROM, ROM + RAM, SEGA, Codemasters, Korean, MSX + Nemesis, Janggun, SG-1000 and many Korean multi-carts.
99
- Automatic region detection: NTSC-JAP, NTSC-USA, PAL-EUR.
10-
- Accurate VDP emulation including timing and Master System 2 only 224 video mode support.
10+
- Accurate VDP emulation, including timing and VDP specifics for SMS, SMS2, GG and TMS9918 modes.
11+
- Support for YM2413 (OPLL) FM sound chip.
12+
- Light Phaser and Paddle Control
1113
- Internal database for rom detection.
1214
- Battery powered RAM save support.
1315
- Save states.
1416
- Game Genie and Pro Action Replay cheat support.
15-
- 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 and QNX.
17+
- 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.
1618

1719
The Gearsystem core has been authored by
1820

@@ -162,21 +164,23 @@ Settings with (Restart) means that core has to be closed for the new setting to
162164
- *NTSC (60 Hz)* forces 60 Hz.
163165
- *PAL (50 Hz)* forces 50 Hz.
164166

165-
- **Aspect Ratio (restart)** [gearsystem_aspect_ratio] (**Auto**|4:3|16:9)
167+
- **Aspect Ratio** [gearsystem_aspect_ratio] (**Auto**|4:3|16:9)
166168

167169
Select which aspect ratio will be presented by the core.
168170

169171
- *1:1 PAR* selects an aspect ratio that produces square pixels.
170-
- *4:3 PAR* forces 4:3 aspect ratio.
171-
- *16:9 PAR* forces 16:9 aspect ratio.
172+
- *4:3 DAR* forces 4:3 aspect ratio.
173+
- *16:9 DAR* forces 16:9 aspect ratio.
174+
- *16:10 DAR* forces 16:10 aspect ratio.
172175

173176
- **Overscan** [gearsystem_overscan] (**Disabled**|Top+Bottom|Full)
174177

175178
Select which overscan (borders) will be used in emulation.
176179

177180
- *Disabled* disables overscan.
178181
- *Top+Bottom* enables overscan for top and bottom.
179-
- *Full* enables overscan for top, bottom, left and right.
182+
- *Full (284 width)* enables overscan for top, bottom, left and right (284 width).
183+
- *Full (320 width)* enables overscan for top, bottom, left and right (320 width).
180184

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

@@ -186,6 +190,13 @@ Settings with (Restart) means that core has to be closed for the new setting to
186190

187191
This option will enable/disable BIOS for Game Gear model. For this to work, the `bios.gg` file must exist in the Retro Arch's system directory.
188192

193+
- **YM2413 (restart)** [gearsystem_ym2413] (**Auto**|Disabled)
194+
195+
This option will enable/disable YM2413 (OPLL) FM sound chip.
196+
197+
- *Auto* selects the best option based in the rom.
198+
- *Disabled* disables YM2413.
199+
189200
- **3D Glasses** [gearsystem_glasses] (**Both Eyes / OFF**|Left Eye|Right Eye)
190201

191202
For games with 3D glasses support this option will let you choose to display only left or right eye.
@@ -202,23 +213,58 @@ Settings with (Restart) means that core has to be closed for the new setting to
202213

203214
It's best to keep this core option disabled.
204215

205-
### Joypad
216+
- **Light Gun Input** [gearsystem_lightgun_input] (**Light Gun**|Touchscreen)
217+
218+
Select which input will be used for Light Gun games.
219+
220+
- *Light Gun* - Selects mouse-controlled 'Light Gun' input (devices will use [RetroLightgun](#lightgun) inputs).
221+
- *Touchscreen* - Selects a touchscreen input (devices will use [RetroPointer](#pointer) inputs instead).
222+
223+
- **Paddle Sensitivity** [gearsystem_paddle_sensitivity] (**1**|1-15)
224+
225+
Set the sensitivity of the [Paddle Control](#mouse).
226+
227+
- *1* is the lowest sensitivity.
228+
- *15* is the highest sensitivity.
229+
230+
## Joypad
206231

207232
![](../image/controller/gg.png)
208233

209234
![](../image/controller/sms.png)
210235

211236
![](../image/controller/sg1000.png)
212237

213-
| User 1 input descriptors | RetroPad Inputs |
214-
|--------------------------|------------------------------------------------|
215-
| 1 | ![](../image/retropad/retro_b.png) |
216-
| Start | ![](../image/retropad/retro_start.png) |
217-
| Up | ![](../image/retropad/retro_dpad_up.png) |
218-
| Down | ![](../image/retropad/retro_dpad_down.png) |
219-
| Left | ![](../image/retropad/retro_dpad_left.png) |
220-
| Right | ![](../image/retropad/retro_dpad_right.png) |
221-
| 2 | ![](../image/retropad/retro_a.png) |
238+
| RetroPad Inputs | SMS / GG Pad |
239+
|------------------------------------------------|--------------------------|
240+
| ![](../image/retropad/retro_dpad_up.png) | Up |
241+
| ![](../image/retropad/retro_dpad_down.png) | Down |
242+
| ![](../image/retropad/retro_dpad_left.png) | Left |
243+
| ![](../image/retropad/retro_dpad_right.png) | Right |
244+
| ![](../image/retropad/retro_b.png) | 1 |
245+
| ![](../image/retropad/retro_a.png) | 2 |
246+
| ![](../image/retropad/retro_start.png) | Pause / Start |
247+
248+
## Lightgun
249+
250+
| RetroLightgun Inputs | [Light Phaser](https://segaretro.org/Light_Phaser) |
251+
|-----------------------|---------------------------------------------------------|
252+
| ![](../image/retromouse/retro_mouse.png) Gun Crosshair | Light Phaser Crosshair |
253+
| Gun Trigger | Light Phaser Trigger |
254+
255+
## Pointer
256+
257+
| RetroPointer Inputs | [Light Phaser](https://segaretro.org/Light_Phaser) |
258+
|-----------------------|-----------------------------------------------------------|
259+
| ![](../image/retromouse/retro_mouse.png) or ![](../image/Button_Pack/Gestures/Gesture_Finger_Front.png) Pointer Position | Light Phaser Crosshair |
260+
| ![](../image/retromouse/retro_left.png) Mouse 1 | Light Phaser Trigger |
261+
262+
## Mouse
263+
264+
| RetroMouse Inputs | [Paddle Control](https://segaretro.org/Paddle_Control) |
265+
|-------------------------------------------------------|-----------------|
266+
| ![](../image/retromouse/retro_mouse.png) Mouse Cursor | Paddle wheel |
267+
| ![](../image/retromouse/retro_left.png) Mouse 1 | Paddle button |
222268

223269
## Compatibility
224270

0 commit comments

Comments
 (0)