Skip to content

Commit acbfef2

Browse files
LibretroAdminLibretroAdmin
authored
Merge pull request #1080 from Clownacy/master
Add docs for ClownMDEmu
2 parents 72a99e2 + d63b5fe commit acbfef2

File tree

7 files changed

+243
-0
lines changed

7 files changed

+243
-0
lines changed

‎docs/development/licenses.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ See below for a summary of the licenses behind RetroArch and its cores:
8686
| [ChaiLove](../library/chailove.md) | [MIT](https://github.com/libretro/libretro-chailove/blob/master/COPYING) | |
8787
| [Citra](../library/citra.md) | [GPLv2](https://github.com/citra-emu/citra/blob/master/license.txt) | |
8888
| [Citra Canary/Experimental](../library/citra_canary.md) | [GPLv2](https://github.com/citra-emu/citra/blob/master/license.txt) | |
89+
| [ClownMDEmu](../library/clownmdemu.md) | [AGPLv3](https://github.com/Clownacy/clownmdemu-libretro/blob/master/LICENCE.txt) | |
8990
| [Craft](../library/craft.md) | [MIT](https://github.com/libretro/Craft/blob/master/LICENSE.md) | |
9091
| [CrocoDS](../library/crocods.md) | [MIT](https://github.com/libretro/libretro-crocods/blob/master/LICENSE) | |
9192
| [DeSmuME 2015](../library/desmume_2015.md) | [GPLv2](https://github.com/libretro/desmume2015/blob/master/desmume/COPYING) | |

‎docs/guides/core-list.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
| [Citra](../library/citra.md) | Nintendo 3DS | |
4747
| Citra 2018 | Nintendo 3DS | |
4848
| [Citra Canary](../library/citra_canary.md) | Nintendo 3DS | Based on Citra development branch |
49+
| [ClownMDEmu](../library/clownmdemu.md) | Sega MD/CD | |
4950
| Craft | Game | A basic clone of the Minecraft sandbox game |
5051
| [CrocoDS](../library/crocods.md) | Amstrad CPC | |
5152
| Cruzes | Game | (Further information required) |

‎docs/guides/retroachievements.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,7 @@ You can also check the progress of your friends and add comments on their trophi
284284
|----------------------------------------------------------------|:---------:|:------|
285285
| [Genesis Plus GX](https://github.com/libretro/Genesis-Plus-GX) | ✔ | Preferred core. |
286286
| [BlastEm](https://github.com/libretro/blastem) | ✕ | Cycle accurate. Genesis/MegaDrive only. Has known issues with game RAM and is incompatible with achievements. |
287+
| [ClownMDEmu](https://github.com/Clownacy/clownmdemu-libretro) | ✕ | |
287288
| [Picodrive](https://github.com/libretro/picodrive) | ✔ | |
288289
| [SMS Plus GX](https://github.com/libretro/smsplus-gx) | ✔ | Master System only |
289290
| [Gearsystem](https://github.com/drhelius/Gearsystem) | ✔ | Master System only |
@@ -320,6 +321,7 @@ You can also check the progress of your friends and add comments on their trophi
320321
| Core | Supported | Notes |
321322
|----------------------------------------------------------------|:---------:|:------|
322323
| [Genesis Plus GX](https://github.com/libretro/Genesis-Plus-GX) | ✔ | |
324+
| [ClownMDEmu](https://github.com/Clownacy/clownmdemu-libretro) | ✕ | |
323325
| [Picodrive](https://github.com/libretro/picodrive) | ✔ | |
324326

325327
#### Saturn

‎docs/guides/softpatching.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ rom.ips2
105105
| Core | Supported |
106106
|--------------------------------------------------|:---------:|
107107
| [BlastEm](../library/blastem.md) | ✔ |
108+
| [ClownMDEmu](../library/clownmdemu.md) | ✔ |
108109
| [Genesis Plus GX](../library/genesis_plus_gx.md) | ✔ |
109110
| [PicoDrive](../library/picodrive.md) | ✕ |
110111

‎docs/library/clownmdemu.md‎

Lines changed: 235 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,235 @@
1+
# ClownMDEmu
2+
3+
## Background
4+
5+
A highly-portable Sega Mega Drive emulator that aims to be as fast as possible without sacrificing accuracy.
6+
7+
The ClownMDEmu core has been authored by:
8+
9+
- Clownacy
10+
11+
The ClownMDEmu core is licensed under:
12+
13+
- [AGPLv3](https://github.com/Clownacy/clownmdemu-libretro/blob/master/LICENCE.txt)
14+
15+
A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md).
16+
17+
## Extensions
18+
19+
Content that can be loaded by the ClownMDEmu core have the following file extensions:
20+
21+
- .bin
22+
- .md
23+
- .gen
24+
- .cue
25+
- .iso
26+
27+
RetroArch database(s) that are associated with the ClownMDEmu core:
28+
29+
- [Sega - Mega Drive - Genesis](https://github.com/libretro/libretro-database/blob/master/rdb/Sega%20-%20Mega%20Drive%20-%20Genesis.rdb)
30+
- [Sega - Mega-CD - Sega CD](https://github.com/libretro/libretro-database/blob/master/rdb/Sega%20-%20Mega-CD%20-%20Sega%20CD.rdb)
31+
32+
## Features
33+
34+
Frontend-level settings or features that the ClownMDEmu core respects:
35+
36+
| Feature | Supported |
37+
|-------------------|-----------|
38+
| Restart | ✔ |
39+
| Saves | ✔ |
40+
| States | ✔ |
41+
| Rewind | ✔ |
42+
| Netplay | ✔ |
43+
| Core Options | ✔ |
44+
| RetroAchievements | ✕ |
45+
| RetroArch Cheats | ✕ |
46+
| Native Cheats | ✕ |
47+
| Controls | ✔ |
48+
| Remapping | ✔ |
49+
| Multi-Mouse | ✕ |
50+
| Rumble | ✕ |
51+
| Sensors | ✕ |
52+
| Camera | ✕ |
53+
| Location | ✕ |
54+
| Subsystem | ✕ |
55+
| [Softpatching](../guides/softpatching.md) | ✔ |
56+
| Disk Control | ✕ |
57+
| Username | ✕ |
58+
| Language | ✕ |
59+
| Crop Overscan | ✕ |
60+
| LEDs | ✕ |
61+
62+
## Directories
63+
64+
The ClownMDEmu core's library name is 'ClownMDEmu'.
65+
66+
The ClownMDEmu core saves/loads to/from these directories.
67+
68+
**Frontend's Save directory**
69+
70+
| File | Description |
71+
|-------|------------------------------|
72+
| *.srm | Mega Drive/Genesis save data |
73+
| *.brm | Mega CD/Sega CD save data |
74+
75+
**Frontend's State directory**
76+
77+
| File | Description |
78+
|----------|-------------|
79+
| *.state# | State |
80+
81+
## Geometry and timing
82+
83+
- The ClownMDEmu core's core-provided FPS is 59.94 for NTSC games and 50 for PAL games
84+
- The ClownMDEmu core's core-provided sample rate is 223721.5625 Hz
85+
- The ClownMDEmu core's base width is 320 (though this varies depending on the loaded content)
86+
- The ClownMDEmu core's base height is 224 (though this varies depending on the loaded content)
87+
- The ClownMDEmu core's max width is 320
88+
- The ClownMDEmu core's max height is 480
89+
- The ClownMDEmu core's core-provided aspect ratio is typically 10:7 (though this varies depending on the loaded content)
90+
91+
## Core options
92+
93+
The ClownMDEmu core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded.
94+
95+
- **Debug > Disable Sprite Plane** [clownmdemu_disable_sprite_plane] (**disabled**|enabled)
96+
97+
Disable the VDP's Sprite Plane.
98+
99+
- **Debug > Disable Window Plane** [clownmdemu_disable_window_plane] (**disabled**|enabled)
100+
101+
Disable the VDP's Window Plane.
102+
103+
- **Debug > Disable Plane A** [clownmdemu_disable_plane_a] (**disabled**|enabled)
104+
105+
Disable the VDP's Plane A.
106+
107+
- **Debug > Disable Plane B** [clownmdemu_disable_plane_b] (**disabled**|enabled)
108+
109+
Disable the VDP's Plane B.
110+
111+
- **Debug > Disable FM1** [clownmdemu_disable_fm1] (**disabled**|enabled)
112+
113+
Disable the YM2612's FM1 channel.
114+
115+
- **Debug > Disable FM2** [clownmdemu_disable_fm2] (**disabled**|enabled)
116+
117+
Disable the YM2612's FM2 channel.
118+
119+
- **Debug > Disable FM3** [clownmdemu_disable_fm3] (**disabled**|enabled)
120+
121+
Disable the YM2612's FM3 channel.
122+
123+
- **Debug > Disable FM4** [clownmdemu_disable_fm4] (**disabled**|enabled)
124+
125+
Disable the YM2612's FM4 channel.
126+
127+
- **Debug > Disable FM5** [clownmdemu_disable_fm5] (**disabled**|enabled)
128+
129+
Disable the YM2612's FM5 channel.
130+
131+
- **Debug > Disable FM6** [clownmdemu_disable_fm6] (**disabled**|enabled)
132+
133+
Disable the YM2612's FM6 channel.
134+
135+
- **Debug > Disable DAC** [clownmdemu_disable_dac] (**disabled**|enabled)
136+
137+
Disable the YM2612's DAC channel.
138+
139+
- **Debug > Disable PSG1** [clownmdemu_disable_psg1] (**disabled**|enabled)
140+
141+
Disable the SN76496's PSG1 channel.
142+
143+
- **Debug > Disable PSG2** [clownmdemu_disable_psg2] (**disabled**|enabled)
144+
145+
Disable the SN76496's PSG2 channel.
146+
147+
- **Debug > Disable PSG3** [clownmdemu_disable_psg3] (**disabled**|enabled)
148+
149+
Disable the SN76496's PSG3 channel.
150+
151+
- **Debug > Disable PSG Noise** [clownmdemu_disable_psg_noise] (**disabled**|enabled)
152+
153+
Disable the SN76496's PSG Noise channel.
154+
155+
- **Debug > Disable PCM1** [clownmdemu_disable_pcm1] (**disabled**|enabled)
156+
157+
Disable the RF5C164's PCM1 channel.
158+
159+
- **Debug > Disable PCM2** [clownmdemu_disable_pcm2] (**disabled**|enabled)
160+
161+
Disable the RF5C164's PCM2 channel.
162+
163+
- **Debug > Disable PCM3** [clownmdemu_disable_pcm3] (**disabled**|enabled)
164+
165+
Disable the RF5C164's PCM3 channel.
166+
167+
- **Debug > Disable PCM4** [clownmdemu_disable_pcm4] (**disabled**|enabled)
168+
169+
Disable the RF5C164's PCM4 channel.
170+
171+
- **Debug > Disable PCM5** [clownmdemu_disable_pcm5] (**disabled**|enabled)
172+
173+
Disable the RF5C164's PCM5 channel.
174+
175+
- **Debug > Disable PCM6** [clownmdemu_disable_pcm6] (**disabled**|enabled)
176+
177+
Disable the RF5C164's PCM6 channel.
178+
179+
- **Debug > Disable PCM7** [clownmdemu_disable_pcm7] (**disabled**|enabled)
180+
181+
Disable the RF5C164's PCM7 channel.
182+
183+
- **Debug > Disable PCM8** [clownmdemu_disable_pcm8] (**disabled**|enabled)
184+
185+
Disable the RF5C164's PCM8 channel.
186+
187+
- **TV Standard** [clownmdemu_tv_standard] (**NTSC (59.94Hz)**|PAL (50Hz))
188+
189+
Which television standard to output in.
190+
191+
- **Console Region** [clownmdemu_overseas_region] (**Overseas (Elsewhere)**|Domestic (Japan))
192+
193+
Which region the console is.
194+
195+
- **Tall Interlace Mode 2** [clownmdemu_tall_interlace_mode_2] (**disabled**|enabled)
196+
197+
Makes games that use Interlace Mode 2 for split-screen not appear squashed.
198+
199+
- **Low-Pass Filter** [clownmdemu_lowpass_filter] (**enabled**|disabled)
200+
201+
Makes the audio sound 'softer', just like on a real Mega Drive.
202+
203+
- **Low-Volume Distortion** [clownmdemu_ladder_effect] (**enabled**|disabled)
204+
205+
Approximates the so-called 'ladder effect' that is present in early Mega Drives. Without this, certain sounds in some games will be too quiet.
206+
207+
## Joypad
208+
209+
| RetroPad Inputs | User 1 - 2 input descriptors |
210+
|------------------------------------------------|------------------------------|
211+
| ![](../image/retropad/retro_b.png) | B |
212+
| ![](../image/retropad/retro_y.png) | A |
213+
| ![](../image/retropad/retro_select.png) | Mode |
214+
| ![](../image/retropad/retro_start.png) | Start |
215+
| ![](../image/retropad/retro_dpad_up.png) | Up |
216+
| ![](../image/retropad/retro_dpad_down.png) | Down |
217+
| ![](../image/retropad/retro_dpad_left.png) | Left |
218+
| ![](../image/retropad/retro_dpad_right.png) | Right |
219+
| ![](../image/retropad/retro_a.png) | C |
220+
| ![](../image/retropad/retro_x.png) | Y |
221+
| ![](../image/retropad/retro_l1.png) | X |
222+
| ![](../image/retropad/retro_r1.png) | Z |
223+
224+
## External links
225+
226+
- [Official ClownMDEmu Website](https://clownmdemu.clownacy.com)
227+
- [Official ClownMDEmu GitHub Repository](https://github.com/Clownacy/clownmdemu-libretro)
228+
- [Libretro ClownMDEmu Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/clownmdemu_libretro.info)
229+
- [Report Libretro ClownMDEmu Core Issues Here](https://github.com/Clownacy/clownmdemu-libretro/issues)
230+
231+
## Sega Mega Drive/Genesis cores
232+
233+
- [Sega - Mega Drive - Genesis (BlastEm)](blastem.md)
234+
- [Sega - MS/GG/MD/CD (Genesis Plus GX)](genesis_plus_gx.md)
235+
- [Sega - MS/MD/CD/32X (PicoDrive)](picodrive.md)

‎docs/meta/see-also.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,8 @@ This is a list of cores that are related to each other in some way.
151151
- [Sega - Master System (Emux SMS)](../library/emux_sms.md)
152152
- [Sega - MS/GG/MD/CD (Genesis Plus GX)](../library/genesis_plus_gx.md)
153153
- [Sega - MS/MD/CD/32X (PicoDrive)](../library/picodrive.md)
154+
- [Sega - MD/CD (BlastEm)](../library/blastem.md)
155+
- [Sega - MD/CD (ClownMDEmu)](../library/clownmdemu.md)
154156
- [Sega - MS/GG/SG-1000 (Gearsystem)](../library/gearsystem.md)
155157
- [Sega - MS/GG (SMS Plus GX)](../library/smsplus.md)
156158
- [MSX/SVI/ColecoVision/SG-1000 (blueMSX)](../library/bluemsx.md)

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,7 @@ nav:
249249
- 'Sega - MS/GG/MD/CD (Genesis Plus GX)': 'library/genesis_plus_gx.md'
250250
- 'Sega - MS/MD/CD/32X (PicoDrive)': 'library/picodrive.md'
251251
- 'Sega - MD/CD (BlastEm)': 'library/blastem.md'
252+
- 'Sega - MD/CD (ClownMDEmu)': 'library/clownmdemu.md'
252253
- 'Sega - Saturn (Beetle Saturn)': 'library/beetle_saturn.md'
253254
- 'Sega - Saturn/ST-V (Kronos)': 'library/kronos.md'
254255
- 'Sega - Saturn (Yabause)': 'library/yabause.md'

0 commit comments

Comments
 (0)