Skip to content

Commit d171c83

Browse files
committed
Update Gearboy docs
1 parent 29f4435 commit d171c83

1 file changed

Lines changed: 65 additions & 14 deletions

File tree

docs/library/gearboy.md

Lines changed: 65 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,7 @@
44

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

7-
- Accurate CPU emulation, passes cpu_instrs.gb from blargg's tests.
8-
- Accurate instruction and memory timing, passes instr_timing.gb and mem_timing.gb from blargg's tests.
9-
- Supported cartridges: ROM, ROM + RAM, MBC1, MBC2, MBC3 + RTC, MBC5, HuC-1 and MBC1M (multicart).
10-
- Accurate LCD controller emulation with correct timings and priorities including mid-scanline effects.
7+
- Accurate emulation supporting cartridges: ROM, ROM + RAM, MBC1, MBC2, MBC3, MBC5, MBC7, HuC-1, HuC-3, MMM01, Pocket Camera, TAMA5 and MBC1M.
118
- Game Boy Color support.
129
- Battery powered RAM save support.
1310
- Save states.
@@ -77,7 +74,7 @@ Frontend-level settings or features that the Gearboy core respects.
7774
| Remapping ||
7875
| Multi-Mouse ||
7976
| Rumble ||
80-
| Sensors | |
77+
| Sensors | |
8178
| Camera ||
8279
| Location ||
8380
| Subsystem ||
@@ -131,17 +128,23 @@ Settings with (restart) means that core has to be closed for the new setting to
131128
- *Game Boy DMG* forces original Game Boy hardware.
132129
- *Game Boy Advance* enables Game Boy Advance hardware.
133130

134-
- **Mapper (restart)** [gearboy_mapper] (**Auto**|ROM Only|MBC 1|MBC 2|MBC 3|MBC 5|MBC 1 Multicart)
131+
- **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)
135132

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

138135
- *Auto* selects the best MBC based on the rom.
139136
- *ROM Only* forces no MBC.
140137
- *MBC 1* forces MBC 1.
141138
- *MBC 2* forces MBC 2.
142-
- *MBC 3* forces MBC 3 + RTC.
139+
- *MBC 3* forces MBC 3.
143140
- *MBC 5* forces MBC 5.
144141
- *MBC 1 Multicart* forces MBC 1 Multicart.
142+
- *HuC 1* forces HuC 1.
143+
- *HuC 3* forces HuC 3.
144+
- *MMM01* forces MMM01.
145+
- *Camera* forces Pocket Camera.
146+
- *MBC 7* forces MBC 7.
147+
- *TAMA5* forces TAMA5.
145148

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

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

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

154-
- **DMG Bootrom** [gearboy_bootrom_dmg] (**Disabled**|Enabled)
157+
- **DMG Bootrom (restart)** [gearboy_bootrom_dmg] (**Disabled**|Enabled)
155158

156-
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.
159+
Enable or disable the original Game Boy bootrom. For this to work, the `dmg_boot.bin` file must exist in RetroArch's system directory.
157160

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

160-
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.
163+
Enable or disable the Game Boy Color bootrom. For this to work, the `cgb_boot.bin` file must exist in RetroArch's system directory.
161164

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

164-
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.
167+
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.
165168

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

168-
It's best to keep this core option disabled.
171+
Select the input source for MBC7 tilt controls.
172+
173+
- **Sensor Sensitivity X (MBC7)** [gearboy_sensor_sensitivity_x] (**5**|1-10)
174+
175+
Set the horizontal sensitivity when using sensor input for MBC7 tilt controls.
176+
177+
- **Sensor Sensitivity Y (MBC7)** [gearboy_sensor_sensitivity_y] (**5**|1-10)
178+
179+
Set the vertical sensitivity when using sensor input for MBC7 tilt controls.
180+
181+
- **Sensor Invert X (MBC7)** [gearboy_sensor_invert_x] (**Disabled**|Enabled)
182+
183+
Invert the horizontal axis when using sensor input for MBC7 tilt controls.
184+
185+
- **Sensor Invert Y (MBC7)** [gearboy_sensor_invert_y] (**Disabled**|Enabled)
186+
187+
Invert the vertical axis when using sensor input for MBC7 tilt controls.
188+
189+
- **Mouse Sensitivity X (MBC7)** [gearboy_mouse_sensitivity_x] (**5**|1-10)
190+
191+
Set the horizontal sensitivity when using mouse input for MBC7 tilt controls.
192+
193+
- **Mouse Sensitivity Y (MBC7)** [gearboy_mouse_sensitivity_y] (**5**|1-10)
194+
195+
Set the vertical sensitivity when using mouse input for MBC7 tilt controls.
196+
197+
- **Mouse Invert X (MBC7)** [gearboy_mouse_invert_x] (**Disabled**|Enabled)
198+
199+
Invert the horizontal axis when using mouse input for MBC7 tilt controls.
200+
201+
- **Mouse Invert Y (MBC7)** [gearboy_mouse_invert_y] (**Disabled**|Enabled)
202+
203+
Invert the vertical axis when using mouse input for MBC7 tilt controls.
204+
205+
- **Analog Sensitivity X (MBC7)** [gearboy_analog_sensitivity_x] (**5**|1-10)
206+
207+
Set the horizontal sensitivity when using analog stick input for MBC7 tilt controls.
208+
209+
- **Analog Sensitivity Y (MBC7)** [gearboy_analog_sensitivity_y] (**5**|1-10)
210+
211+
Set the vertical sensitivity when using analog stick input for MBC7 tilt controls.
212+
213+
- **Analog Invert X (MBC7)** [gearboy_analog_invert_x] (**Disabled**|Enabled)
214+
215+
Invert the horizontal axis when using analog stick input for MBC7 tilt controls.
216+
217+
- **Analog Invert Y (MBC7)** [gearboy_analog_invert_y] (**Disabled**|Enabled)
218+
219+
Invert the vertical axis when using analog stick input for MBC7 tilt controls.
169220

170221
## Joypad
171222

0 commit comments

Comments
 (0)