Emulation/docs
1
0
Fork 0
mirror of https://github.com/libretro/docs.git synced 2024-06-23 14:52:10 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add new Gearcoleco core

Browse source
This commit is contained in:
Ignacio Sanchez Gines 2021-09-06 16:08:06 +02:00
parent beedfc4dc8
commit d42d033c08
No known key found for this signature in database
GPG key ID: 9991E3DF4B412A05
10 changed files with 177 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/development/licenses.md
View file

@ -117,6 +117,7 @@ See below for a summary of the licenses behind RetroArch and its cores:
| [Gambatte](../library/gambatte.md) | [GPLv2](https://github.com/libretro/gambatte-libretro/blob/master/COPYING) | |
| [Game Music Emu](../library/game_music_emu.md) | [GPLv3](https://github.com/libretro/libretro-gme/blob/master/LICENSE) | |
| [Gearboy](../library/gearboy.md) | [GPLv3](https://github.com/libretro/Gearboy/blob/master/LICENSE) | |
| [Gearcoleco](../library/gearcoleco.md) | [GPLv3](https://github.com/drhelius/Gearcoleco/blob/master/LICENSE) | |
| [Gearsystem](../library/gearsystem.md) | [GPLv3](https://github.com/drhelius/Gearsystem/blob/master/LICENSE) | |
| [Genesis Plus GX](../library/genesis_plus_gx.md) | [Non-commercial](https://github.com/libretro/Genesis-Plus-GX/blob/master/LICENSE.txt) | Non-commercial |
| [gpSP](../library/gpsp.md) | [GPLv2](https://github.com/libretro/gpsp/blob/master/COPYING) | |

1
docs/guides/retroachievements.md
View file

@ -101,6 +101,7 @@ You can also check the progress of your friends and add comments on their trophi
| [SMS Plus GX](https://github.com/libretro/smsplus-gx) | ✔ | |
| [blueMSX](https://github.com/libretro/blueMSX-libretro) | ✔ | |
| [FinalBurn Neo](https://github.com/libretro/FBNeo) | ✔ | Requires games in `coleco` subdirectory, exact archives just like arcade. Not all games may be linked for this core. |
| [Gearcoleco](https://github.com/drhelius/Gearcoleco) | ✔ | |
### GCE

6
docs/guides/softpatching.md
View file

@ -10,6 +10,12 @@ RetroArch currently supports UPS, IPS and BPS patching formats. If you load `rom
|--------------------------------------------|:---------:|
| [Beetle Cygne](../library/beetle_cygne.md) | ✔ |
### Coleco - ColecoVision
| Core | Supported |
|--------------------------------------------|:---------:|
| [Gearcoleco](../library/gearcoleco.md) | ✔ |
### Nintendo - Game Boy / Color
| Core | Supported |

1
docs/library/bios.md
View file

@ -48,6 +48,7 @@ System | Core | Link |
Arcade | MAME2003 | [BIOS information](mame_2003.md#bios)
Arcade | MAME2003+ | [BIOS information](mame2003_plus.md#bios)
Arcade | MAME2010 | [BIOS information](mame_2010.md#bios)
ColecoVision | Gearcoleco | [BIOS information](gearcoleco.md#bios)
Dreamcast | Flycast | [BIOS information](flycast.md#bios)
DS | DeSmuME | [BIOS information](desmume.md#bios)
GameBoy/GameBoy Color | Emux GB | [BIOS information](emux_gb.md#bios)

4
docs/library/bluemsx.md
View file

@ -344,3 +344,7 @@ Supported combinations
#### Microsoft - MSX2
- [Microsoft - MSX (fMSX)](fmsx.md)
#### ColecoVision
- [Coleco - ColecoVision (Gearcoleco)](gearcoleco.md)

157
docs/library/gearcoleco.md Normal file
View file

@ -0,0 +1,157 @@
# Coleco - ColecoVision (GearColeco)
## Background
Gearcoleco is an open source, cross-platform, ColecoVision emulator written in C++.
- Accurate Z80 core, including undocumented opcodes and behavior like R and MEMPTR registers.
- Accurate TMS9918 emulation.
- Sound emulation using a fine tuned Sms_Snd_Emu library.
- Battery powered RAM save support.
- 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.
The Gearcoleco core has been authored by
- [Ignacio Sanchez (drhelius)](https://github.com/drhelius)
The Gearcoleco core is licensed under
- [GPLv3](https://github.com/drhelius/Gearcoleco/blob/master/LICENSE)
A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md).
## BIOS
Gearcoleco require a BIOS file to work.
Required or optional firmware files go in the frontend's system directory.
!!! attention
Gearcoleco emulator requires a ColecoVision BIOS. In order to get it to work you must place the following file in RetroArch's system directory.
| Filename | Description | md5sum |
|:-----------------:|:----------------------------------:|:--------------------------------:|
| colecovision.rom | ColecoVision BIOS - Mandatory | 2c66f5911e5b42b8ebe113403548eee7 |
## Extensions
Content that can be loaded by the Gearcoleco core have the following file extensions:
- .col
- .cv
- .bin
- .rom
RetroArch database(s) that are associated with the Gearcoleco core:
- [Coleco - ColecoVision](https://github.com/libretro/libretro-database/blob/master/rdb/Coleco%20-%20ColecoVision.rdb)
## Features
Frontend-level settings or features that the Gearcoleco core respects.
| Feature | Supported |
|-------------------|:---------:|
| Restart | ✔ |
| Screenshots | ✔ |
| Saves | ✔ |
| States | ✔ |
| Rewind | ✔ |
| Netplay | ✕ |
| Core Options | ✔ |
| RetroAchievements | ✔ |
| RetroArch Cheats | ✕ |
| Native Cheats | ✕ |
| Controls | ✔ |
| Remapping | ✔ |
| Multi-Mouse | ✕ |
| Rumble | ✕ |
| Sensors | ✕ |
| Camera | ✕ |
| Location | ✕ |
| Subsystem | ✕ |
| [Softpatching](../guides/softpatching.md) | ✔ |
| Disk Control | ✕ |
| Username | ✕ |
| Language | ✕ |
| Crop Overscan | ✕ |
| LEDs | ✕ |
### Directories
The Gearcoleco core's library name is 'Gearcoleco'
The Gearcoleco core saves/loads to/from these directories.
**Frontend's Save directory**
| File | Description |
|:-----:|:----------------------:|
| *.srm | Cartridge battery save |
**Frontend's State directory**
| File | Description |
|:--------:|:-----------:|
| *.state# | State |
### Geometry and timing
- The Gearcoleco core's core provided FPS is 60 for NTSC games and 50 for PAL games
- The Gearcoleco core's core provided sample rate is 44100 Hz
- The Gearcoleco core's width is 256
- The Gearcoleco core's height is 192
- The Gearcoleco core's core provided aspect ratio is 4:3
## Core options
The Gearcoleco core has the following options that can be tweaked from the core options menu. The default setting is bolded.
Settings with (Restart) means that core has to be closed for the new setting to be applied on next launch.
- **Refresh Rate (restart)** [gearcoleco_timing] (**Auto**|NTSC (60 Hz)|PAL (50 Hz))
Select which refresh rate will be used in emulation.
- *Auto* selects the best refresh rate based in the rom.
- *NTSC (60 Hz)* forces 60 Hz.
- *PAL (50 Hz)* forces 50 Hz.
- **Allow Up+Down / Left+Right** [gearcoleco_up_down_allowed] (**Disabled**|Enabled)
Enabling this will allow pressing / quickly alternating / holding both left and right (or up and down in some games) directions at the same time.
This may cause movement based glitches to occur in certain games.
It's best to keep this core option disabled.
### Joypad
| User 1 and User 2 input descriptors | RetroPad Inputs |
|-------------------------------------|------------------------------------------------|
| Up | ![](../image/retropad/retro_dpad_up.png) |
| Down | ![](../image/retropad/retro_dpad_down.png) |
| Left | ![](../image/retropad/retro_dpad_left.png) |
| Right | ![](../image/retropad/retro_dpad_right.png) |
| Left Button | ![](../image/retropad/retro_a.png) |
| Right Button | ![](../image/retropad/retro_b.png) |
| 1 | ![](../image/retropad/retro_x.png) |
| 2 | ![](../image/retropad/retro_y.png) |
| 3 | ![](../image/retropad/retro_r1.png) |
| 4 | ![](../image/retropad/retro_l1.png) |
| 5 | ![](../image/retropad/retro_r2.png) |
| 6 | ![](../image/retropad/retro_l2.png) |
| 7 | ![](../image/retropad/retro_r3.png) |
| 8 | ![](../image/retropad/retro_l3.png) |
| * | ![](../image/retropad/retro_select.png) |
| # | ![](../image/retropad/retro_start.png) |
## External Links
- [Official Gearcoleco Repository](https://github.com/drhelius/Gearcoleco)
- [Libretro Gearcoleco Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/gearcoleco_libretro.info)
- [Report Gearcoleco Core Issues Here](https://github.com/drhelius/Gearcoleco/issues)
### See also
- [MSX/SVI/ColecoVision/SG-1000 (blueMSX)](bluemsx.md)

1
docs/library/smsplus.md
View file

@ -184,3 +184,4 @@ The SMS Plus GX core supports the following device type(s) in the controls menu,
- [Sega - MS/MD/CD/32X (PicoDrive)](picodrive.md)
- [Sega - MS/GG/SG-1000 (Gearsystem)](gearsystem.md)
- [MSX/SVI/ColecoVision/SG-1000 (blueMSX)](bluemsx.md)
- [Coleco - ColecoVision (Gearcoleco)](gearcoleco.md)

1
docs/meta/core-list.md
View file

@ -59,6 +59,7 @@
- Gambatte
- Game Music Emu
- Gearboy
- Gearcoleco
- Gearsystem
- Genesis Plus GX
- gpSP

4
docs/meta/see-also.md
View file

@ -151,3 +151,7 @@ This is a list of cores that are related to each other in some way.
- [FB Alpha 2012 CPS-2](../library/fb_alpha_cps2.md)
- [FB Alpha 2012 CPS-3](../library/fb_alpha_cps3.md)
- [FB Alpha 2012 Neo Geo](../library/fb_alpha_neogeo.md)
## ColecoVision
- [Coleco - ColecoVision (Gearcoleco)](../library/gearcoleco.md)

1
mkdocs.yml
View file

@ -107,6 +107,7 @@ nav:
- 'Bandai - WonderSwan/Color (Beetle Cygne)': 'library/beetle_cygne.md'
- 'Bandai - Wonderswan Compatibility List': 'library/compatibility/wswan.md'
- 'ColecoVision Emulation':
- 'ColecoVision (Gearcoleco)': 'library/gearcoleco.md'
- 'MSX/SVI/ColecoVision/SG-1000 (blueMSX)': 'library/bluemsx.md'
- 'Commodore Emulation':
- 'Commodore - 8-bit (VICE)': 'library/vice.md'