Skip to content

Commit 35ce5b9

Browse files
carmikercarmiker
committed
Add JollyCV documentation
- Also do some little cleanups
1 parent 597b4eb commit 35ce5b9

File tree

7 files changed

+208
-2
lines changed

7 files changed

+208
-2
lines changed

‎docs/development/licenses.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ See below for a summary of the licenses behind RetroArch and its cores:
138138
| [Hatari](../library/hatari.md) | [GPLv2](https://github.com/libretro/hatari/blob/master/readme.txt) | |
139139
| [higan Accuracy](../library/higan_accuracy.md) | [GPLv3](https://gitlab.com/higan/higan/blob/master/LICENSE.txt) | |
140140
| [Imageviewer](../library/imageviewer.md) | [MIT](https://github.com/libretro/RetroArch/blob/master/cores/libretro-imageviewer/LICENSE) | |
141+
| [JollyCV](../library/jollycv.md) | [BSD-3-Clause, MIT](https://github.com/libretro/jollycv/blob/master/LICENSE) | |
141142
| [Kronos](../library/kronos.md) | [GPLv2](https://github.com/libretro/yabause/blob/kronos/yabause/COPYING) | |
142143
| [LowRES NX](../library/lowres_nx.md) | [zlib](https://github.com/timoinutilis/lowres-nx/blob/master/LICENSE) | |
143144
| [Lutro](../library/lutro.md) | [MIT](https://github.com/libretro/libretro-lutro/blob/master/LICENSE) | |

‎docs/guides/core-list.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@
102102
| [Geargrafx](../library/geargrafx.md) | NEC PC Engine/SuperGrafx | |
103103
| [Gearsystem](../library/gearsystem.md) | Sega MS/GG/SG-1000 | |
104104
| Genesis Plus GX | Sega MS/GG/MD/CD | |
105-
| Geolith | SNK Neo Geo AES/MVS | Highly accurate emulator for the Neo Geo AES and MVS Cartridge Systems |
105+
| [Geolith](../library/geolith.md) | SNK Neo Geo AES/MVS | Highly accurate emulator for the Neo Geo AES and MVS Cartridge Systems |
106106
| [gpSP](../library/gpsp.md) | Game Boy Advance | |
107107
| Gong | Game | A clone of Pong written for libretro |
108108
| GW | Handheld Electronic | A simulator of various Game and Watch-style handheld electronic games |
@@ -114,6 +114,7 @@
114114
| Imageviewer | Imageviewer | A basic core for viewing still images in a libretro frontend |
115115
| Ishiiruka | Nintendo GameCube/Wii | |
116116
| JAXE | CHIP-8/S-CHIP/XO-CHIP | |
117+
| [JollyCV](../library/jollycv.md) | ColecoVision/CreatiVision/My Vision | |
117118
| Jump 'n Bump | Game engine | A reimplementation of the engine of Jump 'n Bump, a open-source MS-DOS multiplayer video game by Brainchild Design |
118119
| Kronos | Sega Saturn/ST-V | A port of the Kronos, which is itself a fork of Yabause emulator |
119120
| LowRes NX | Game engine | A port of the LowRes NX fantasy console to libretro |

‎docs/guides/retroachievements.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,11 @@ You can also check the progress of your friends and add comments on their trophi
113113

114114
| Core | Supported | Notes |
115115
|---------------------------------------------------------|:---------:|:------|
116-
| [SMS Plus GX](https://github.com/libretro/smsplus-gx) | ✕ | |
117116
| [blueMSX](https://github.com/libretro/blueMSX-libretro) | ✔ | |
118117
| [FinalBurn Neo](https://github.com/libretro/FBNeo) | ✕ | |
119118
| [Gearcoleco](https://github.com/drhelius/Gearcoleco) | ✔ | |
119+
| [JollyCV](https://github.com/libretro/jollycv) | ✔ | |
120+
| [SMS Plus GX](https://github.com/libretro/smsplus-gx) | ✕ | |
120121

121122
### GCE
122123

‎docs/library/bluemsx.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,3 +356,4 @@ Supported combinations
356356
#### ColecoVision
357357

358358
- [Coleco - ColecoVision (Gearcoleco)](gearcoleco.md)
359+
- [ColecoVision/CreatiVision/My Vision (JollyCV)](jollycv.md)

‎docs/library/gearcoleco.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,4 +200,5 @@ Settings with (restart) means that core has to be closed for the new setting to
200200

201201
### See also
202202

203+
- [ColecoVision/CreatiVision/My Vision (JollyCV)](jollycv.md)
203204
- [MSX/SVI/ColecoVision/SG-1000 (blueMSX)](bluemsx.md)

‎docs/library/jollycv.md‎

Lines changed: 200 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,200 @@
1+
# ColecoVision/CreatiVision/My Vision (JollyCV)
2+
3+
## Background
4+
5+
JollyCV is a multi-emulator supporting ColecoVision (including Super Game Module support), CreatiVision, and My Vision. JollyCV is fast, accurate, and highly portable.
6+
7+
The JollyCV core has been authored by
8+
9+
- [Rupert Carmichael (carmiker)](https://github.com/carmiker)
10+
11+
The JollyCV core is licensed under
12+
13+
- [BSD-3-Clause](https://github.com/libretro/jollycv/blob/master/LICENSE)
14+
15+
A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md).
16+
17+
## BIOS
18+
19+
JollyCV requires a BIOS file for ColecoVision and CreatiVision content.
20+
21+
Required or optional firmware files go in the frontend's system directory.
22+
23+
!!! attention
24+
JollyCV requires a BIOS for ColecoVision or CreatiVision content. Place the following files in RetroArch's system directory.
25+
26+
| Filename | Description | md5sum |
27+
|:-----------------:|:----------------------------------:|:--------------------------------:|
28+
| coleco.rom | ColecoVision BIOS - Required | 2c66f5911e5b42b8ebe113403548eee7 |
29+
| bioscv.rom | CreatiVision BIOS - Required | 3b1ef759d8e3fb4071582efd33dd05f9 |
30+
31+
## Extensions
32+
33+
Content that can be loaded by the Gearcoleco core have the following file extensions:
34+
35+
- .col
36+
- .rom
37+
- .myv
38+
- .bin
39+
40+
RetroArch database(s) that are associated with the JollyCV core:
41+
42+
- [Coleco - ColecoVision](https://github.com/libretro/libretro-database/blob/master/rdb/Coleco%20-%20ColecoVision.rdb)
43+
44+
## Features
45+
46+
Frontend-level settings or features that the JollyCV core respects.
47+
48+
| Feature | Supported |
49+
|-------------------|:---------:|
50+
| Restart | ✔ |
51+
| Screenshots | ✔ |
52+
| Saves | ✔ |
53+
| States | ✔ |
54+
| Rewind | ✔ |
55+
| Netplay | ✔ |
56+
| Core Options | ✔ |
57+
| RetroAchievements | ✔ |
58+
| RetroArch Cheats | ✕ |
59+
| Native Cheats | ✕ |
60+
| Controls | ✔ |
61+
| Remapping | ✔ |
62+
| Multi-Mouse | ✕ |
63+
| Rumble | ✕ |
64+
| Sensors | ✕ |
65+
| Camera | ✕ |
66+
| Location | ✕ |
67+
| Subsystem | ✕ |
68+
| Softpatching | ✕ |
69+
| Disk Control | ✕ |
70+
| Username | ✕ |
71+
| Language | ✕ |
72+
| Crop Overscan | ✔ |
73+
| LEDs | ✕ |
74+
75+
### Directories
76+
77+
The JollyCV core's library name is 'JollyCV'
78+
79+
The JollyCV core saves/loads to/from these directories.
80+
81+
**Frontend's Save directory**
82+
83+
| File | Description |
84+
|:-----:|:----------------------:|
85+
| *.srm | Cartridge save |
86+
87+
**Frontend's State directory**
88+
89+
| File | Description |
90+
|:--------:|:-----------:|
91+
| *.state# | State |
92+
93+
### Geometry and timing
94+
95+
- The JollyCV core's core provided FPS is 60 for NTSC and 50 for PAL
96+
- The JollyCV core's core provided sample rate is 48000Hz
97+
- The JollyCV core provides adjustable overscan masking and aspect ratio options
98+
99+
## Core options
100+
101+
The JollyCV core has the following options that can be tweaked from the core options menu. The default setting is bolded.
102+
103+
- **TMS9918 Palette** [jollycv_tmspalette] (**TeaTime**|SYoung|GCDatasheet)
104+
105+
Set the Palette
106+
107+
- **Aspect Ratio** [jollycv_aspect] (**Region-based Pixel Aspect Ratio**|Perfectly Square Pixels (1:1 PAR)|Very Traditional NTSC Aspect Ratio (4:3 DAR)|Ostensibly Accurate PAL Aspect Ratio)
108+
109+
Set the Aspect Ratio
110+
111+
- **Mask Overscan (Top)** [jollycv_overscan_t] (16|14|12|10|8|6|4|2|**0**)
112+
113+
Mask off pixels hidden by a bezel or border on original CRTs (top)
114+
115+
- **Mask Overscan (Bottom)** [jollycv_overscan_b] (16|14|12|10|8|6|4|2|**0**)
116+
117+
Mask off pixels hidden by a bezel or border on original CRTs (bottom)
118+
119+
- **Mask Overscan (Left)** [jollycv_overscan_l] (8|**6**|4|2|0)
120+
121+
Mask off pixels hidden by a bezel or border on original CRTs (left)
122+
123+
- **Mask Overscan (Right)** [jollycv_overscan_r] (8|**6**|4|2|0)
124+
125+
Mask off pixels hidden by a bezel or border on original CRTs (right)
126+
127+
### Input Devices
128+
129+
| ColecoVision Paddle (Super Action) | RetroPad Inputs |
130+
|-------------------------------------|------------------------------------------------|
131+
| Up | ![](../image/retropad/retro_dpad_up.png) |
132+
| Down | ![](../image/retropad/retro_dpad_down.png) |
133+
| Left | ![](../image/retropad/retro_dpad_left.png) |
134+
| Right | ![](../image/retropad/retro_dpad_right.png) |
135+
| Yellow (Fire L) | ![](../image/retropad/retro_b.png) |
136+
| Orange (Fire R) | ![](../image/retropad/retro_a.png) |
137+
| Purple | ![](../image/retropad/retro_y.png) |
138+
| Blue | ![](../image/retropad/retro_x.png) |
139+
| 1 | ![](../image/retropad/retro_l2.png) ![](../image/retropad/retro_b.png) |
140+
| 2 | ![](../image/retropad/retro_l2.png) ![](../image/retropad/retro_a.png) |
141+
| 3 | ![](../image/retropad/retro_l2.png) ![](../image/retropad/retro_y.png) |
142+
| 4 | ![](../image/retropad/retro_l2.png) ![](../image/retropad/retro_x.png) |
143+
| 5 | ![](../image/retropad/retro_r2.png) ![](../image/retropad/retro_b.png) |
144+
| 6 | ![](../image/retropad/retro_r2.png) ![](../image/retropad/retro_a.png) |
145+
| 7 | ![](../image/retropad/retro_r2.png) ![](../image/retropad/retro_y.png) |
146+
| 8 | ![](../image/retropad/retro_r2.png) ![](../image/retropad/retro_x.png) |
147+
| 9 | ![](../image/retropad/retro_l2.png) ![](../image/retropad/retro_select.png) |
148+
| 0 | ![](../image/retropad/retro_r2.png) ![](../image/retropad/retro_select.png) |
149+
| * | ![](../image/retropad/retro_select.png) |
150+
| # | ![](../image/retropad/retro_start.png) |
151+
| Spinner- | ![](../image/retropad/retro_l1.png) |
152+
| Spinner+ | ![](../image/retropad/retro_r1.png) |
153+
154+
| CreatiVision Paddle | RetroPad Inputs |
155+
|-------------------------------------|------------------------------------------------|
156+
| Up | ![](../image/retropad/retro_dpad_up.png) |
157+
| Down | ![](../image/retropad/retro_dpad_down.png) |
158+
| Left | ![](../image/retropad/retro_dpad_left.png) |
159+
| Right | ![](../image/retropad/retro_dpad_right.png) |
160+
| Fire L | ![](../image/retropad/retro_b.png) |
161+
| Fire R | ![](../image/retropad/retro_a.png) |
162+
| Start 1 | ![](../image/retropad/retro_select.png) |
163+
| Start 2 | ![](../image/retropad/retro_start.png) |
164+
| Reset | ![](../image/retropad/retro_l2.png) ![](../image/retropad/retro_select.png) |
165+
| Reset | ![](../image/retropad/retro_l2.png) ![](../image/retropad/retro_start.png) |
166+
167+
| My Vision | RetroPad Inputs |
168+
|-------------------------------------|------------------------------------------------|
169+
| B (Up) | ![](../image/retropad/retro_dpad_up.png) |
170+
| C (Down) | ![](../image/retropad/retro_dpad_down.png) |
171+
| A (Left) | ![](../image/retropad/retro_dpad_left.png) |
172+
| D (Right) | ![](../image/retropad/retro_dpad_right.png) |
173+
| E | ![](../image/retropad/retro_select.png) |
174+
| 1 | ![](../image/retropad/retro_b.png) |
175+
| 2 | ![](../image/retropad/retro_a.png) |
176+
| 3 | ![](../image/retropad/retro_y.png) |
177+
| 4 | ![](../image/retropad/retro_x.png) |
178+
| 5 | ![](../image/retropad/retro_l2.png) ![](../image/retropad/retro_b.png) |
179+
| 6 | ![](../image/retropad/retro_l2.png) ![](../image/retropad/retro_a.png) |
180+
| 7 | ![](../image/retropad/retro_l2.png) ![](../image/retropad/retro_y.png) |
181+
| 8 | ![](../image/retropad/retro_l2.png) ![](../image/retropad/retro_x.png) |
182+
| 9 | ![](../image/retropad/retro_r2.png) ![](../image/retropad/retro_b.png) |
183+
| 10 | ![](../image/retropad/retro_r2.png) ![](../image/retropad/retro_a.png) |
184+
| 11 | ![](../image/retropad/retro_r2.png) ![](../image/retropad/retro_y.png) |
185+
| 12 | ![](../image/retropad/retro_r2.png) ![](../image/retropad/retro_x.png) |
186+
| 13 | ![](../image/retropad/retro_r1.png) |
187+
| 14 | ![](../image/retropad/retro_start.png) |
188+
189+
190+
## External Links
191+
192+
- [Upstream JollyCV Repository](https://gitlab.com/jgemu/jollycv)
193+
- [Libretro JollyCV Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/jollycv_libretro.info)
194+
- [Libretro JollyCV Repository](https://github.com/libretro/jollycv)
195+
- [Report JollyCV Core Issues Here](https://github.com/libretro/jollycv/issues)
196+
197+
### See also
198+
199+
- [Coleco - ColecoVision (Gearcoleco)](gearcoleco.md)
200+
- [MSX/SVI/ColecoVision/SG-1000 (blueMSX)](bluemsx.md)

‎docs/meta/see-also.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ This is a list of cores that are related to each other in some way.
2323
## ColecoVision
2424

2525
- [Coleco - ColecoVision (Gearcoleco)](../library/gearcoleco.md)
26+
- [Coleco - ColecoVision (JollyCV)](../library/jollycv.md)
2627

2728
## CPC
2829

0 commit comments

Comments
 (0)