f2f9793631bf37b2af7db1fcd8a4828110ae1dbe
[picodrive.git] / base_readme.txt
1 #\r
2 PicoDrive 1.xx\r
3 \r
4 About\r
5 -----\r
6 \r
7 #ifdef PSP\r
8 This is yet another Megadrive / Genesis emulator for PSP, but with\r
9 Sega CD / Mega CD support. Although it has been originally written having\r
10 ARM CPU based devices in mind, it has now been ported to PSP too, by\r
11 replacing ARM specific parts with portable C code.\r
12 The base code originates from Dave's (fdave, finalburn) PicoDrive 0.30 for\r
13 Pocket PC. The Sega/Mega CD code is roughly based on Stephane Dallongeville's\r
14 Gens.\r
15 #else\r
16 This is yet another Megadrive / Genesis / Sega CD / Mega CD / 32X / SMS\r
17 emulator, which was written having ARM-based handheld devices in mind\r
18 (such as PDAs, smartphones and handheld consoles like GP2X and Gizmondo\r
19 of course).\r
20 The emulator is heavily optimized for ARM, features assembly cores for\r
21 68k, Z80 and VDP chip emulation, also has dynamic recompilers for SH2 and\r
22 SSP16 (for 32X and SVP emulation). It was started by Dave (aka fdave,\r
23 finalburn author) as basic Genesis/Megadrive emulator for Pocket PC,\r
24 then taken over by notaz and developed primarily for GPH devices.\r
25 #endif\r
26 \r
27 PicoDrive is the first emulator ever to properly emulate Virtua Racing and\r
28 it's SVP chip.\r
29 \r
30 \r
31 How to make it run\r
32 ------------------\r
33 \r
34 #ifdef GP2X\r
35 Extract all files to some directory on your SD and run PicoDrive.gpe from your\r
36 GP2X/Wiz/Caanoo menu. The same .gpe supports GP2X F100/F200, Wiz and Caanoo,\r
37 there is no need to use separate versions.\r
38 Then load a ROM and enjoy! ROMs can be in .smd or .bin format and can be zipped.\r
39 Sega/Mega CD images can be in ISO/CSO+MP3/WAV or CUE+BIN formats (read below\r
40 for more details).\r
41 #endif\r
42 #ifdef GIZ\r
43 First make sure you have homebrew-enabled Service Pack installed. Then copy\r
44 PicoDrive.exe and KGSDK.dll to any place in your filesystem (both files must\r
45 be in the same directory) and run PicoDrive.exe using the launcher of your choice\r
46 (some of them might require renaming PicoDrive.exe to Autorun.exe, placing it in\r
47 the root of SD, etc). Then load a ROM and enjoy! ROMs can be placed anywhere, can\r
48 be in .smd or .bin format and can be zipped (one ROM per zip).\r
49 #endif\r
50 #ifdef PSP\r
51 If you are running a custom firmware, just copy the whole PicoDrive directory to\r
52 /PSP/GAME or /PSP/GAMEXXX directory in your memory stick (it shouldn't matter\r
53 which one GAME* directory to use).\r
54 \r
55 If you are on 1.5, there is a separate KXploited version for it.\r
56 #endif\r
57 #ifdef UIQ\r
58 Copy SIS and some ROMs to any directory in your memory stick, and install the SIS.\r
59 Then load a ROM and enjoy! ROMs can be in .smd or .bin format and can be zipped.\r
60 #endif\r
61 #ifdef PANDORA\r
62 Just copy the .pnd to <sd card>/pandora/menu or <sd card>/pandora/desktop.\r
63 #endif\r
64 #ifndef UIQ\r
65 \r
66 This emulator has lots of options with various tweaks (for improved speed mostly),\r
67 but it should have best compatibility in it's default config. If suddently you\r
68 start getting glitches or change something and forget what, use "Restore defaults"\r
69 option.\r
70 #endif\r
71 \r
72 \r
73 How to run Sega/Mega CD games\r
74 -----------------------------\r
75 \r
76 To play any game, you need BIOS files. These files must be copied to\r
77 #ifdef UIQ\r
78 D:\other\PicoDrive\ directory.\r
79 #else\r
80 #ifdef PANDORA\r
81 <sd card>/pandora/appdata/PicoDrive/ directory\r
82 (if you run PicoDrive once it will create that directory for you).\r
83 #else\r
84 the same directory as PicoDrive files.\r
85 #endif\r
86 #endif\r
87 Files can be named as follows:\r
88 \r
89 US: us_scd1_9210.bin us_scd2_9306.bin SegaCDBIOS9303.bin\r
90 EU: eu_mcd1_9210.bin eu_mcd2_9303.bin eu_mcd2_9306.bin\r
91 JP: jp_mcd1_9112.bin jp_mcd1_9111.bin\r
92 these files can also be zipped.\r
93 \r
94 The game must be dumped to ISO/CSO+MP3/WAV or CUE+BIN format. When using\r
95 CUE/BIN, you must load .cue file from the menu, or else the emu will not find\r
96 audio tracks.\r
97 CUE/BIN usually takes a lot of space, so it can be converted to cue/cso/mp3 by\r
98 #ifdef PANDORA\r
99 using bin_to_cso_mp3 tool, which can be downloaded from:\r
100 http://notaz.gp2x.de/releases/misc/bin_to_cso_mp3.zip\r
101 See readme in the bin_to_cso_mp3/ directory for details.\r
102 #else\r
103 using bin_to_cso_mp3 tool, which is included with the emulator. See readme in\r
104 the bin_to_cso_mp3/ directory for details.\r
105 #endif\r
106 \r
107 ISO+mp3 files can be named similarly as for other emus.\r
108 Here are some examples:\r
109 \r
110 SonicCD.iso             data track\r
111 SonicCD_02.mp3          audio track 1 (CD track 2)\r
112 SonicCD_03.mp3\r
113 ...\r
114 \r
115 Sonic the Hedgehog CD (US) - Track 01.iso\r
116 Sonic the Hedgehog CD (US) - Track 02.mp3\r
117 Sonic the Hedgehog CD (US) - Track 03.mp3\r
118 ...\r
119 \r
120 In case there is a .cue file with properly specified files names in it,\r
121 file naming doesn't matter. Just be sure to load .cue from the menu.\r
122 \r
123 It is very important to have the MP3s encoded at 44kHz sample rate and they\r
124 must be stereo, or else they will play too fast/slow or won't play at all.\r
125 Be sure NOT to use anything but classic mp3 format (don't use things like\r
126 mp3pro).\r
127 \r
128 ISO files can also be .cso compressed or zipped (but not mp3 files, as they\r
129 are already compressed). CSO will cause slightly longer loading times, and\r
130 is not very good for FMV games. Zipping ISOs is not recommended, as it will\r
131 cause very long (several minute) loading times, and make some games\r
132 unplayable. File naming is similar as with uncompressed ISOs.\r
133 Example:\r
134 \r
135 SonicCD.cso             data track\r
136 SonicCD_02.mp3          audio track 1 (CD track 2)\r
137 SonicCD_03.mp3\r
138 ...\r
139 \r
140 \r
141 Other important stuff\r
142 ---------------------\r
143 \r
144 * Sega/Mega CD: If the game hangs after Sega logo, you may need to enable\r
145   "better sync" and/or "Scale/Rot. fx" options, found in "Sega/Mega CD options"\r
146   submenu, and then reset the game. Some other games may also require\r
147   "CDDA audio" and "PCM audio" to be enabled to work (enabled by default).\r
148   Incorrectly named/missing mp3s may also be the cause.\r
149 * Sega/Mega CD: If the background music is missing, you might have named your\r
150   MP3s incorrectly. Read "How to run Sega/Mega CD games" section again.\r
151 * Sega/Mega CD: If the game music plays too fast/too slow/out of sync, you have\r
152   encoded your MP3s incorrectly. You will have to re-encode and/or resample them.\r
153   PicoDrive is not a mp3 player, so all mp3s MUST be encoded at 44.1kHz stereo.\r
154   Badly encoded mp3s can cause various kind of problems, like noises, incorrect\r
155   playback speeds, not repeating music or even prevent game from starting.\r
156   Some games (like Snatcher) may hang in certain scenes because of this.\r
157   Some mp3 rippers/encoders remove silence and beginning/end of audio tracks,\r
158   what causes audio desyncs and/or mentioned problems.\r
159   If you have cue/bin rip, you can use the bin_to_cso_mp3 tool (included with\r
160   the emulator) to make a proper iso/mp3 rip.\r
161 * Sega/Mega CD: If your games hangs at the BIOS screen (with planets shown),\r
162   you may be using a bad BIOS dump. Try another from a different source.\r
163 * Some Sega/Mega CD games don't use Z80 for anything, but they leave it active,\r
164   so disabling Z80 manually (in advanced options) improves performance.\r
165 * Use lower bitrate for better performance (96 or 128kbps CBRs recommended).\r
166 #ifdef GP2X\r
167 * GP2X F100/F200: When you use both GP2X CPUs, keep in mind that you can't\r
168   overclock as high as when using ARM920 only. For example my GP2X when run\r
169   singlecore can reach 280MHz, but with both cores it's about 250MHz. When\r
170   overclocked too much, it may start hanging and producing random noise, or\r
171   causing ARM940 crashes ("940 crashed" message displayed).\r
172 * GP2X F100/F200: Due to internal implementation mp3s must not be larger that\r
173   12MB (12582912 bytes). Larger mp3s will not be fully loaded.\r
174 #endif\r
175 \r
176 \r
177 Configuration\r
178 -------------\r
179 \r
180 #ifdef UIQ\r
181 #include "config.txt"\r
182 #else\r
183 @@0. "Save slot"\r
184 This is a slot number to use for savestates, when done by a button press outside\r
185 menu. This can also be configured to be changed with a button\r
186 (see "key configuration").\r
187 \r
188 @@0. "Frameskip"\r
189 How many frames to skip rendering before displaying another.\r
190 "Auto" is recommended.\r
191 \r
192 @@0. "Region"\r
193 This option lets you force the game to think it is running on machine from the\r
194 specified region, or just to set autodetection order. Also affects Sega/Mega CD.\r
195 \r
196 @@0. "Show FPS"\r
197 Self-explanatory. Format is XX/YY, where XX is the number of rendered frames and\r
198 YY is the number of emulated frames per second.\r
199 \r
200 @@0. "Enable sound"\r
201 Does what it says. You must enable at least YM2612 or SN76496 (in advanced options,\r
202 see below) for this to make sense (already done by default).\r
203 \r
204 @@0. "Sound Quality"\r
205 #ifdef PSP\r
206 Sound sample rate, affects sound quality and emulation performance.\r
207 22050Hz setting is the recommended one.\r
208 #else\r
209 Sound sample rate and stereo mode. Mono is not available in Sega/Mega CD mode.\r
210 #endif\r
211 \r
212 @@0. "Confirm savestate"\r
213 Allows to enable confirmation on savestate saving (to prevent savestate overwrites),\r
214 on loading (to prevent destroying current game progress), and on both or none, when\r
215 using shortcut buttons (not menu) for saving/loading.\r
216 \r
217 #ifdef GP2X\r
218 @@0. "GP2X CPU clocks"\r
219 Here you can change clocks of both GP2X's CPUs. Larger values increase performance.\r
220 There is no separate option for the second CPU because both CPUs use the same clock\r
221 source. Setting this option to 200 will cause PicoDrive NOT to change GP2X's clocks\r
222 at all (this is if you use external program to set clock).\r
223 #endif\r
224 #ifdef PSP\r
225 @@0. "CPU/bus clock"\r
226 This allows to change CPU and bus clocks for PSP. 333MHz is recommended.\r
227 #endif\r
228 \r
229 @@0. "[Display options]"\r
230 Enters Display options menu (see below).\r
231 \r
232 @@0. "[Sega/Mega CD options]"\r
233 Enters Sega/Mega CD options menu (see below).\r
234 \r
235 @@0. "[32X options]"\r
236 Enters 32X options menu (see below).\r
237 \r
238 @@0. "[Advanced options]"\r
239 Enters advanced options menu (see below).\r
240 \r
241 @@0. "Save cfg as default"\r
242 If you save your config here it will be loaded on next ROM load, but only if there\r
243 is no game specific config saved (which will be loaded in that case).\r
244 You can press left/right to switch to a different config profile.\r
245 \r
246 @@0. "Save cfg for current game only"\r
247 Whenever you load current ROM again these settings will be loaded.\r
248 \r
249 @@0. "Restore defaults"\r
250 Restores all options (except controls) to defaults.\r
251 \r
252 \r
253 Display options\r
254 ---------------\r
255 \r
256 #ifndef PANDORA\r
257 @@1. "Renderer"\r
258 #ifdef GP2X\r
259 8bit fast:\r
260 This enables alternative heavily optimized tile-based renderer, which renders\r
261 pixels not line-by-line (this is what accurate renderers do), but in 8x8 tiles,\r
262 which is much faster. But because of the way it works it can't render any\r
263 mid-frame image changes (raster effects), so it is useful only with some games.\r
264 \r
265 Other two are accurate line-based renderers. The 8bit is faster but does not\r
266 run well with some games like Street Racer.\r
267 \r
268 #endif\r
269 #ifdef GIZ\r
270 This option allows to switch between 16bit and 8bit renderers. The 8bit one is\r
271 a bit faster for some games, but not much, because colors still need to be\r
272 converted to 16bit, as this is what Gizmondo requires. It also introduces\r
273 graphics problems for some games, so it's best to use 16bit one.\r
274 \r
275 #endif\r
276 #ifdef PSP\r
277 This option allows to switch between fast and accurate renderers. The fast one\r
278 is much faster, because it draws the whole frame at a time, instead of doing it\r
279 line by line, like the accurate one does. But because of the way it works it\r
280 can't render any mid-frame image changes (raster effects), so it is useful only\r
281 for some games.\r
282 \r
283 #endif\r
284 #endif\r
285 #ifdef GP2X\r
286 @@1. "Tearing Fix"\r
287 Wiz only: works around the tearing problem by using portrait mode. Causes ~5-10%\r
288 performance hit, but eliminates the tearing effect.\r
289 \r
290 @@1. "Gamma correction"\r
291 F100/F200 only: Alters image gamma through GP2X hardware. Larger values make\r
292 image to look brighter, lower - darker (default is 1.0).\r
293 \r
294 @@1. "A_SN's gamma curve"\r
295 F100/F200 only: If this is enabled, different gamma adjustment method will be\r
296 used (suggested by A_SN from gp32x boards). Intended to be used for F100, makes\r
297 difference for dark and bright colors.\r
298 \r
299 @@1. "Vsync"\r
300 This one adjusts the LCD refresh rate to better match game's refresh rate and\r
301 starts synchronizing rendering with it. Should make scrolling smoother and\r
302 eliminate tearing on F100/F200.\r
303 #endif\r
304 #ifdef GIZ\r
305 @@1. "Scanline mode"\r
306 This option was designed to work around slow framebuffer access (the Gizmondo's\r
307 main bottleneck) by drawing every other line (even numbered lines only).\r
308 This improves performance greatly, but looses detail.\r
309 \r
310 @@1. "Scale low res mode"\r
311 The Genesis/Megadrive had several graphics modes, some of which were only 256\r
312 pixels wide. This option scales their width to 320 by using simple\r
313 pixel averaging scaling. Works only when 16bit renderer is enabled.\r
314 \r
315 @@1. "Double buffering"\r
316 Draws the display to offscreen buffer, and flips it with visible one when done.\r
317 Unfortunately this causes serious tearing, unless v-sync is used (next option).\r
318 \r
319 @@1. "Wait for V-sync"\r
320 Waits for vertical sync before drawing (or flipping buffers, if previous option\r
321 is enabled). Emulation is stopped while waiting, so this causes large performance\r
322 hit.\r
323 #endif\r
324 #ifdef PSP\r
325 @@1. "Scale factor"\r
326 This allows to resize the displayed image by using the PSP's hardware. The number is\r
327 used to multiply width and height of the game image to get the size of image to be\r
328 displayed. If you just want to make it fullscreen, just use "Set to fullscreen"\r
329 setting below.\r
330 \r
331 @@1. "Hor. scale (for low res. games)"\r
332 This one works similarly as the previous setting, but can be used to apply additional\r
333 scaling horizontally, and is used for games which use lower (256 pixel wide) Gen/MD\r
334 resolution.\r
335 \r
336 @@1. "Hor. scale (for hi res. games)"\r
337 Same as above, only for higher (320 pixel wide) resolution using games.\r
338 \r
339 @@1. "Bilinear filtering"\r
340 If this is enabled, PSP hardware will apply bilinear filtering on the resulting image,\r
341 making it smoother, but blurry.\r
342 \r
343 @@1. "Gamma adjustment"\r
344 Color gamma can be adjusted with this.\r
345 \r
346 @@1. "Black level"\r
347 This can be used to reduce unwanted "ghosting" effect for dark games, by making\r
348 black pixels brighter. Use in conjunction with "gamma adjustment" for more effect.\r
349 \r
350 @@1. "Wait for v-sync"\r
351 Wait for the screen to finish updating before switching to next frame, to avoid tearing.\r
352 There are 3 options:\r
353 * never: don't wait for vsync.\r
354 * sometimes: wait only if emulator is running fast enough.\r
355 * always: always wait (causes emulation slowdown).\r
356 \r
357 @@1. "Set to unscaled centered"\r
358 Adjust the resizing options to set game image to it's original size.\r
359 \r
360 @@1. "Set to 4:3 scaled"\r
361 Scale the image up, but keep 4:3 aspect, by adding black borders.\r
362 \r
363 @@1. "Set to fullscreen"\r
364 Adjust the resizing options to make the game image fullscreen.\r
365 #endif\r
366 #ifdef PANDORA\r
367 Allows to set up scaling, filtering and vertical sync.\r
368 #endif\r
369 \r
370 \r
371 Sega/Mega CD options \r
372 --------------------\r
373 \r
374 @@2. "CD LEDs"\r
375 The Sega/Mega CD unit had two blinking LEDs (red and green) on it. This option\r
376 will display them on top-left corner of the screen.\r
377 \r
378 @@2. "CDDA audio"\r
379 This option enables CD audio playback.\r
380 \r
381 @@2. "PCM audio"\r
382 This enables 8 channel PCM sound source. It is required for some games to run,\r
383 because they monitor state of this audio chip.\r
384 \r
385 @@2. "ReadAhead buffer"\r
386 This option can prefetch more data from the CD image than requested by game\r
387 (to avoid accessing card later), what can improve performance in some cases.\r
388 #ifndef PSP\r
389 "OFF" is the recommended setting.\r
390 #endif\r
391 \r
392 @@2. "Save RAM cart"\r
393 Here you can enable 64K RAM cart. Format it in BIOS if you do.\r
394 \r
395 @@2. "Scale/Rot. fx"\r
396 The Sega/Mega CD had scaling/rotation chip, which allows effects similar to\r
397 "Mode 7" effects in SNES. Disabling may improve performance but cause graphical\r
398 glitches.\r
399 \r
400 @@2. "Better sync"\r
401 This option is similar to "Perfect synchro" in Gens. Some games require it to run,\r
402 for example most (all?) Wolfteam games, and some other ones. Don't use it for\r
403 games which don't need it, it will just slow them down.\r
404 \r
405 \r
406 32X options\r
407 -----------\r
408 \r
409 @@3. "32X enabled"\r
410 Enables emulation of addon. Option only takes effect when ROM is reloaded.\r
411 \r
412 #ifdef GP2X\r
413 @@3. "32X renderer"\r
414 This currently only affects how the Genesis/MD layers are rendered, which is\r
415 same as "Renderer" in display options.\r
416 \r
417 #endif\r
418 @@3. "PWM sound"\r
419 Emulates PWM sound portion of 32X hardware. Disabling this may greatly improve\r
420 performance for games that dedicate one of SD2s for sound, but will cause\r
421 missing sound effects and instruments.\r
422 \r
423 @@3. "Master SH2 cycles" / "Slave SH2 cycles"\r
424 This allows underclocking the 32X CPUs for better emulation performance. The\r
425 number has the same meaning as cycles in DOSBox, which is cycles per millisecond.\r
426 Underclocking too much may cause various in-game glitches.\r
427 \r
428 \r
429 Advanced configuration\r
430 ----------------------\r
431 \r
432 @@4. "Use SRAM/BRAM savestates"\r
433 This will automatically read/write SRAM (or BRAM for Sega/Mega CD) savestates for\r
434 games which are using them. SRAM is saved whenever you enter the menu or exit the\r
435 emulator.\r
436 \r
437 @@4. "Disable sprite limit"\r
438 The MegaDrive/Genesis had a limit on how many sprites (usually smaller moving\r
439 objects) can be displayed on single line. This option allows to disable that\r
440 limit. Note that some games used this to hide unwanted things, so it is not\r
441 always good to enable this option.\r
442 \r
443 @@4. "Emulate Z80"\r
444 Enables emulation of Z80 chip, which was mostly used to drive the other sound chips.\r
445 Some games do complex sync with it, so you must enable it even if you don't use\r
446 sound to be able to play them.\r
447 \r
448 @@4. "Emulate YM2612 (FM)"\r
449 This enables emulation of six-channel FM sound synthesizer chip, which was used to\r
450 produce sound effects and music.\r
451 \r
452 @@4. "Emulate SN76496 (PSG)"\r
453 This enables emulation of PSG (programmable sound generation) sound chip for\r
454 additional effects.\r
455 \r
456 Note: if you change sound settings AFTER loading a ROM, you may need to reset\r
457 game to get sound. This is because most games initialize sound chips on\r
458 startup, and this data is lost when sound chips are being enabled/disabled.\r
459 \r
460 @@4. "gzip savestates"\r
461 This will always apply gzip compression on your savestates, allowing you to\r
462 save some space and load/save time.\r
463 \r
464 @@4. "Don't save last used ROM"\r
465 This will disable writing last used ROM to config on exit (what might cause SD\r
466 card corruption according to DaveC).\r
467 \r
468 @@4. "Disable idle loop patching"\r
469 Idle loop patching is used to improve performance, but may cause compatibility\r
470 problems in some rare cases. Try disabling this if your game has problems.\r
471 \r
472 @@4. "Disable frame limiter"\r
473 This allows games to run faster then 50/60fps, useful for benchmarking.\r
474 \r
475 #ifdef GP2X\r
476 @@4. "Use ARM940 core for sound"\r
477 F100/F200: This option causes PicoDrive to use ARM940T core (GP2X's second CPU)\r
478 for sound (i.e. to generate YM2612 samples) to improve performance noticeably.\r
479 It also decodes MP3s in Sega/Mega CD mode.\r
480 \r
481 @@4. "RAM overclock"\r
482 This overclocks the GP2X RAM chips for improved performance, but may cause\r
483 instability. Keep it enabled if it doesn't cause problems.\r
484 \r
485 @@4. "MMU hack"\r
486 Makes framebuffer bufferable for improved performance. There are no drawbacks\r
487 so it should be left enabled.\r
488 \r
489 @@4. "SVP dynarec"\r
490 This enables dynamic recompilation for SVP chip emulated for Virtua Racing game,\r
491 what improves it's emulation performance greatly.\r
492 #endif\r
493 \r
494 \r
495 Key configuration\r
496 -----------------\r
497 \r
498 Select "Configure controls" from the main menu. Then select "Player 1" and you will\r
499 see two columns. The left column lists names of Genesis/MD controller buttons, and\r
500 the right column your handheld ones, which are assigned.\r
501 #ifndef PANDORA\r
502 If you bind 2 different buttons to the same action, you will get a combo\r
503 (which means that you will have to press both buttons for that action to happen).\r
504 #endif\r
505 \r
506 There is also option to enable 6 button pad (will allow you to configure XYZ\r
507 buttons), and an option to set turbo rate (in Hz) for turbo buttons.\r
508 #ifndef UIQ\r
509 \r
510 \r
511 Cheat support\r
512 -------------\r
513 \r
514 To use GG/patch codes, you must type them into your favorite text editor, one\r
515 per line. Comments may follow code after a whitespace. Only GameGenie and\r
516 Genecyst patch formats are supported.\r
517 Examples:\r
518 \r
519 Genecyst patch (this example is for Sonic):\r
520 \r
521 00334A:0005 Start with five lives\r
522 012D24:0001 Keep invincibility until end of stage\r
523 009C76:5478 each ring worth 2\r
524 009C76:5678 each ring worth 3\r
525 ...\r
526 \r
527 Game Genie patch (for Sonic 2):\r
528 \r
529 ACLA-ATD4 Hidden palace instead of death egg in level select\r
530 ...\r
531 \r
532 Both GG and patch codes can be mixed in one file.\r
533 \r
534 When the file is ready, name it just like your ROM file, but with additional\r
535 .pat extension, making sure that case matches.\r
536 \r
537 Examples:\r
538 \r
539 ROM: Sonic.zip\r
540 PATCH FILE: Sonic.zip.pat\r
541 \r
542 ROM: Sonic 2.bin\r
543 PATCH FILE: Sonic 2.bin.pat\r
544 \r
545 Put the file into your ROMs directory. Then load the .pat file as you would\r
546 a ROM. Then Cheat Menu Option should appear in main menu.\r
547 #endif\r
548 \r
549 \r
550 What is emulated?\r
551 -----------------\r
552 \r
553 Genesis/MegaDrive:\r
554 #ifdef PSP\r
555 main 68k @ 7.6MHz: yes, FAME/C core\r
556 z80 @ 3.6MHz: yes, CZ80 core\r
557 #else\r
558 main 68k @ 7.6MHz: yes, Cyclone core\r
559 z80 @ 3.6MHz: yes, DrZ80 core\r
560 #endif\r
561 VDP: yes, except some quirks and modes not used by games\r
562 YM2612 FM: yes, optimized MAME core\r
563 SN76489 PSG: yes, MAME core\r
564 SVP chip: yes! This is first emu to ever do this.\r
565 Some in-cart mappers are also supported.\r
566 \r
567 Sega/Mega CD:\r
568 #ifdef PSP\r
569 another 68k @ 12.5MHz: yes, FAME/C too\r
570 #else\r
571 another 68k @ 12.5MHz: yes, Cyclone too\r
572 #endif\r
573 gfx scaling/rotation chip (custom ASIC): yes\r
574 PCM sound source: yes\r
575 CD-ROM controller: yes (mostly)\r
576 bram (internal backup RAM): yes\r
577 \r
578 32X:\r
579 2x SH2 @ 23MHz: yes, custom recompiler\r
580 Super VDP: yes\r
581 PWM: yes\r
582 \r
583 \r
584 Problems / limitations\r
585 ----------------------\r
586 \r
587 #ifdef PSP\r
588 * SVP emulation is terribly slow.\r
589 #endif\r
590 * Various VDP modes and quirks (window bug, scroll size 2, etc.) are not\r
591   emulated, as very few games use this (if any at all).\r
592 * The emulator is not 100% accurate, so some things may not work as expected.\r
593 * The FM sound core doesn't support all features and has some accuracy issues.\r
594 \r
595 \r
596 Credits\r
597 -------\r
598 \r
599 This emulator is made of the code from following people/projects:\r
600 \r
601 notaz\r
602 GP2X, UIQ, PSP, Gizmondo ports, CPU core hacks, dynamic recompilers,\r
603 lots of additional coding (see changelog).\r
604 Homepage: http://notaz.gp2x.de/\r
605 \r
606 fDave\r
607 one who started it all:\r
608 Cyclone 68000 core and PicoDrive itself\r
609 \r
610 #ifdef PSP\r
611 Chui\r
612 FAME/C 68k interpreter core\r
613 (based on C68K by Stephane Dallongeville)\r
614 \r
615 Stephane Dallongeville (written), NJ (optimized)\r
616 CZ80 Z80 interpreter core\r
617 \r
618 #else\r
619 Reesy & FluBBa\r
620 DrZ80, the Z80 interpreter written in ARM assembly.\r
621 Homepage: http://reesy.gp32x.de/\r
622 \r
623 #endif\r
624 Tatsuyuki Satoh, Jarek Burczynski, MAME development\r
625 software implementation of Yamaha FM sound generator\r
626 \r
627 MAME development\r
628 Texas Instruments SN76489 / SN76496 programmable tone/noise generator\r
629 Homepage: http://www.mame.net/\r
630 \r
631 Stephane Dallongeville\r
632 Gens, MD/Mega CD/32X emulator. Most Sega CD code is based on this emu.\r
633 #ifdef PSP\r
634 \r
635 people @ ps2dev.org forums / PSPSDK crew\r
636 libaudiocodec code (by cooleyes)\r
637 other sample code\r
638 #else\r
639 \r
640 Helix community\r
641 Helix mp3 decoder\r
642 #endif\r
643 \r
644 \r
645 Additional thanks\r
646 -----------------\r
647 \r
648 * Charles MacDonald (http://cgfm2.emuviews.com/) for old but still very useful\r
649   info about genesis hardware.\r
650 * Steve Snake for all that he has done for Genesis emulation scene.\r
651 * Tasco Deluxe for his reverse engineering work on SVP and some mappers.\r
652 * Bart Trzynadlowski for his SSFII and 68000 docs.\r
653 * Haze for his research (http://haze.mameworld.info).\r
654 * Lordus, Exophase and Rokas for various ideas.\r
655 * Nemesis for his YM2612 research.\r
656 * Many posters at spritesmind.net forums for valuable information.\r
657 * Mark and Jean-loup for zlib library.\r
658 * ketchupgun for the skin.\r
659 #ifdef GP2X\r
660 * rlyeh and all the other people behind the minimal library.\r
661 * Squidge for his famous squidgehack(tm).\r
662 * Dzz for his ARM940 sample code.\r
663 * A_SN for his gamma code.\r
664 * craigix for supplying the GP2X hardware and making this port possible.\r
665 * Alex for the icon.\r
666 * All the people from gp32x boards for their support.\r
667 #endif\r
668 #ifdef GIZ\r
669 * Kingcdr's for the SDK and Reesy for the DLL and sound code.\r
670 * jens.l for supplying the Gizmondo hardware and making this port possible.\r
671 #endif\r
672 #ifdef UIQ\r
673 * Peter van Sebille for his various open-source Symbian projects to learn from.\r
674 * Steve Fischer for his open-source Motorola projects.\r
675 * The development team behind "Symbian GCC Improvement Project"\r
676   (http://www.inf.u-szeged.hu/symbian-gcc/) for their updated pre-SymbianOS9\r
677   compile tools.\r
678 * AnotherGuest for all his Symbian stuff and support.\r
679 #endif\r
680 * Inder for some graphics.\r
681 * Anyone else I forgot. You know who you are.\r
682 \r
683 \r
684 Changelog\r
685 ---------\r
686 1.80\r
687   + Added Caanoo support. Now the GP2X binary supports GP2X F100/F200, Wiz\r
688     and Caanoo. Lots of internal refactoring to support this.\r
689   + Enabled 32X and SMS code. It's still unfinished but better release something\r
690     now than wait even more (it has been in development for more then a year now\r
691     due to various other projects or simply lack of time).\r
692   + Pandora: added hardware scaler support, including ability to resize the\r
693     layer and control filtering.\r
694   + GP2X: Added basic line-doubling vertical scaling option.\r
695   * Changed the way keys are bound, no need to unbind old one any more.\r
696   * Handle MP3s with ID3 tags better (some MP3s with ID3 did not play).\r
697   * Improved shadow/hilight color levels.\r
698   * Fixed broken cheat support.\r
699 \r
700 1.80beta2\r
701   * Pandora: updated documentation.\r
702 \r
703 1.80beta1\r
704   + Added pandora port.\r
705   * Internal refactoring for 32x/SMS support.\r
706   * Move mapper database to external file.\r
707   + Added preliminary SMS emulation.\r
708   + Added emulation of 32x peripherals including VDP. More work is needed here.\r
709   + ARM: Added new SH2 recompiler for 32x. Some unification with SVP one.\r
710   - Disabled most of the above bacause I'm not yet happy with the results.\r
711 \r
712 1.56\r
713   * Changed sync in Sega CD emulation again. Should fix games that\r
714     broke after changes in 1.51a.\r
715   * Fixed default keys rebinding when they shouldn't.\r
716   * Fixed sram being loaded from wrong game.\r
717   * Emu should no longer hang shortly after using fast-forward.\r
718   * Fixed save states sometimes no longer showing up in save state menu.\r
719   * ARM: some asm code refactoring for slight speed improvement.\r
720 \r
721 1.55\r
722   + Added Wiz support. Now the same GP2X binary supports F100/F200 and Wiz.\r
723   * Changed shadow/hilight handling a bit, fixes some effects in Pirates! Gold.\r
724   * Complete input code rewrite. This fixes some limitations like not allowing\r
725     to control both players using single input device. It also allows to use\r
726     more devices (like keyboards) on Linux based devices.\r
727   * Options menu has been reordered, "restore defaults" option added.\r
728 \r
729 1.51b\r
730   * Fixed a crash when uncompressed savestate is loaded.\r
731   * Fixed an idle loop detection related hanging problem.\r
732   * PSP: fixed another palette related regression.\r
733   * UIQ3: updated frontend for the latest emu core.\r
734 \r
735 1.51a\r
736   * Fixed a sync problem between main and sub 68k. Should fix the hanging\r
737     problem for some games.\r
738   * ARM: fixed a crash when CD savestate is loaded just after loading ROM.\r
739 \r
740 1.51\r
741   * Improved bin_to_cso_mp3 tool, it should no longer complain about\r
742     missing lame.exe even if it's in working dir.\r
743   * Fixed a regression from 1.50, which caused slowdowns in Final Fight.\r
744   * Fixed some regressions from 1.50 related to sprite limit and palette\r
745     handling (caused graphical glitches in some games).\r
746   + Added ABC turbo actions to key config.\r
747   * Some other minor adjustments.\r
748 \r
749 1.50\r
750   + Added some basic support for Sega Pico, a MegaDrive-based toy.\r
751   + Added proper support for cue/bin images, including cdda playback.\r
752     .cue sheets with iso/cso/mp3/wav files listed in them are now\r
753     supported too (but 44kHz restriction still applies).\r
754   + Added bin_to_cso_mp3 tool, based on Exophase's bin_to_iso_ogg.\r
755     The tool can convert .cue/.bin Sega CD images to .cso/.mp3.\r
756   * Greatly improved Sega CD load times.\r
757   * Changed how scheduling between 68k and z80 is handled. Improves\r
758     performance for some games. Credits to Lordus for the idea.\r
759   * YM2612 state was not 100% saved, this should be better now.\r
760   * Improved renderer performance for shadow/hilight mode.\r
761   * Added a hack for YM2612 frequency overflow issue (bleep noises\r
762     in Shaq Fu, Spider-Man - The Animated Series (intro music), etc.)\r
763     Credits to Nemesis @ spritesmind forum. Works only if sound rate\r
764     is set to 44kHz.\r
765   + Implemented some sprite rendering improvements, as suggested by\r
766     Exophase. Games with lots of sprites now perform better.\r
767   + Added better idle loop detection, based on Lordus' idea again.\r
768   - "accurate timing" option removed, as disabling it no longer\r
769     improves performance.\r
770   - "accurate sprites" was removed too, the new sprite code can\r
771     properly handle sprite priorities in all cases.\r
772   * Timers adjusted again.\r
773   * Improved .smd detection code.\r
774   * ARM: fixed a bug in DrZ80 core, which could cause problems in\r
775     some rare cases.\r
776   * ARM: fixed a problem of occasional clicks on MP3 music start.\r
777   * Minor general optimizations and menu improvements.\r
778   * Fixed a bug in Sega CD savestate loader, where the game would\r
779     sometimes crash after load.\r
780   * Fixed a crash of games using eeprom (introduced in 1.40b).\r
781   * PSP: fixed suspend/resume (hopefully for real).\r
782 \r
783 1.40c\r
784   * Fixed a problem with sound in Marble Madness.\r
785   * GP2X: Fixed minor problem with key config.\r
786 \r
787 1.40b\r
788   * Fixed sprite masking code. Thanks to Lordus for explaining how it works.\r
789   + Added "disable sprite limit" option.\r
790   + PSP: added black level adjustment to display options.\r
791   * Changed reset to act as 'soft' reset.\r
792   + Added detection for Puggsy (it doesn't really have sram).\r
793   * Some small timing adjustments.\r
794 \r
795 1.40a\r
796   * GP2X: Fixed a binding problem with up and down keys.\r
797   * Default game config no longer overrides global user config.\r
798 \r
799 1.40\r
800   + Added support for SVP (Sega Virtua Processor) to emulate Virtua Racing,\r
801     wrote ARM recompiler and some HLE code for VR. Credits to Exophase and\r
802     Rokas for various ideas.\r
803   * Changed config file format, files are now human-readable. Game specific\r
804     configs are now held in single file (but old game config files are still\r
805     read when new one is missing).\r
806   * Fixed a bug where some key combos didn't work as expected.\r
807   * Fixed a regression in renderer (ARM ports only, some graphic glitches in\r
808     rare cases).\r
809   * Adjusted fast renderer to work with more games, including VR.\r
810   * Fixed a problem where SegaCD RAM cart data was getting lost on reset.\r
811   * GP2X: Greatly reduced SegaCD FMV game slowdowns by disabling read-ahead\r
812     in the Linux kernel and C library (thanks to Rokas and Exophase for ideas\r
813     again). Be sure to keep "ReadAhead buffer" OFF to avoid slowdowns.\r
814   + PicoDrive now comes with a game config file for some games which need\r
815     special settings, so they should now work out-of-the-box. More games will\r
816     be added with later updates.\r
817   + GP2X: Files now can be deleted by pressing A+SELECT in the file browser.\r
818 \r
819 1.35b\r
820   * PSP: mp3 code should no longer fail on 1.5 firmware.\r
821   + PSP: added gamma adjustment option.\r
822   + Added .cso ISO format support. Useful for non-FMV games.\r
823   * It is now possile to force a region after the ROM is loaded.\r
824   * Fixed a sram bug in memhandlers (fixes Shining in the Darkness saves).\r
825   * PSP: fixed another bug in memhanlers, which crashed the emu for some games\r
826     (like NBA Jam and NHL 9x).\r
827   + PSP: added suspend/resume handling for Sega CD games.\r
828   + GP2X: added additional low volume levels for my late-night gaming sessions\r
829     (in stereo mode only).\r
830   + GP2X: added "fast forward" action in key config. Not recommended to use for\r
831     Sega CD, may case problems there.\r
832   * Some other small tweaks I forgot about.\r
833 \r
834 1.35a\r
835   * PSP: fixed a bug which prevented to load any ROMs after testing the BIOS.\r
836   * PSP: fixed incorrect CZ80 memory map setup, which caused Z80 crashes and\r
837     graphics corruption in EU Mega CD model1 BIOS menus.\r
838   + PSP: added additional "set to 4:3 scaled" display option for convenience.\r
839   + PSP: Added an option to disable frame limitter (works only with non-auto frameskip).\r
840 \r
841 1.35\r
842   + PSP port added. Lots of new code for it. Integrated modified FAME/C, CZ80 cores.\r
843   + Some minor generic optimizations.\r
844   * Patched some code which was crashing under PSP, but was working in GP2X/Giz\r
845     (although it should have crashed there too).\r
846   * Readme updated.\r
847 \r
848 1.34\r
849   + Gizmondo port added.\r
850   + Some new optimizations in memory handlers, and for shadow/hilight mode.\r
851   + Added some hacks to make more games work without enabling "accurate timing".\r
852   * Adjusted timing for "accurate timing" mode and added preliminary VDP FIFO\r
853     emulation. Fixes Double Dragon 2, tearing in Chaos Engine and some other games.\r
854   * Fixed a few games not having sound at startup.\r
855   * Updated serial EEPROM code to support more games. Thanks to EkeEke for\r
856     providing info about additional EEPROM types and game mappers.\r
857   * The above change fixed hang of NBA Jam.\r
858   * Minor adjustments to control configurator.\r
859 \r
860 1.33\r
861   * Updated Cyclone core to 0.0088.\r
862   + Added A r k's usbjoy fix.\r
863   + Added "perfect vsync" option, which adjusts GP2X LCD refresh rate and syncs\r
864     emulation to it to eliminate tearing and ensure smoothest scrolling possible.\r
865   + Added an option to use A_SN's gamma curve for gamma correction (improves dark\r
866     and bright color display for mk2s).\r
867   * Sometimes stray sounds were played after loading a savestate. Fixed.\r
868   * Fixed a problem where >6MB mp3s were corrupted in memory (sound glitches in\r
869     Snatcher).\r
870   * PD no longer overwrites video player code in memory, video player now can be\r
871     used after exiting PicoDrive.\r
872   * Fixed a bug which was causing Sonic 3 code to deadlock in some rare conditions\r
873     if "accurate timing" was not enabled.\r
874   * Fixed support for large hacked ROMs like "Ultimate Mortal Kombat Trilogy".\r
875     Upto 10MB hacked ROMs are supported now.\r
876   + Config profiles added (press left/right when saving config).\r
877   * Changed key configuration behavior to the one from gpfce (should be more\r
878     intuitive).\r
879   + Added some skinning capabilities to the menu system with default skin by\r
880     ketchupgun. Delete skin directory if you want old behaviour.\r
881   * Some other little tweaks I forgot about.\r
882 \r
883 1.32\r
884   + Added some new scaling options.\r
885   + Added ability to reload CD images while game is running (needed for games\r
886     with multiple CDs, like Night Trap).\r
887   + Added RAM cart emulation.\r
888   * Fixed DMA timing emulation (caused lock-ups for some genesis games).\r
889   * Idle loop detection was picking up wrong code and causing glitches, fixed.\r
890   * The ym2612 code on 940 now can handle multiple updates per frame\r
891     (fixes Thunger Force III "seiren" level drums for example).\r
892   * Memory handlers were ignoring some writes to PSG chip, fixed (missing sounds in\r
893     Popful Mail, Silpheed).\r
894   * Improved z80 timing, should fix some sound problems.\r
895   * Fixed a bug with sram register (fixes Phantasy Star 4).\r
896   * ROM loader was incorrectly identifying some ROMs as invalid. Fixed.\r
897   * Added code for PRG ram write protection register (Dungeon Explorer).\r
898   * The memory mode register change in 1.31 was unsafe and caused some glitches in\r
899     AH-3 Thunderstrike. Fixed.\r
900   * Fixed a file descriptor leak.\r
901   * Updated documentation, added Gmenu2x manual.\r
902 \r
903 1.31\r
904   * Changed the way memory mode register is read (fixes Lunar 2, broken in 1.30).\r
905   * Fixed TAS opcode on sub-68k side (fixes Batman games).\r
906   * File browser now filters out mp3s, saves and some other files, which are not ROMS.\r
907 \r
908 1.30\r
909   + ISO files now can be zipped. Note that this causes VERY long loading times.\r
910   + Added data pre-buffering support, this allows to reduce frequency of short pauses\r
911     in FMV games (caused by SD access), but makes those pauses longer.\r
912   * Fixed PCM DMA transfers (intro FMV in Popful Mail).\r
913   + Properly implemented "decode" data transformation (Jaguar XJ220).\r
914   * Integrated "better sync" code into cyclone code, what made this mode much faster.\r
915   * Fixed a bug related to game specific config saving.\r
916   * Frameskipper was skipping sound processing, what caused some audio desyncs. Fixed.\r
917   * Fixed reset not working for some games.\r
918   + New assembly optimized memory handlers for CD (gives at least a few fps).\r
919     Also re-enabled all optimizations from 0.964 release.\r
920   + New idle-loop detection code for sub-68k. Speeds up at least a few games.\r
921 \r
922 1.201\r
923   + Added basic cheat support (GameGenie and Genecyst patches).\r
924 \r
925 1.20\r
926   * Fixed a long-standing problem in audio mixing code which caused slight distortions\r
927     at lower sample rates.\r
928   * Changed the way 920 and 940 communicates (again), should be more reliable and give\r
929     slight performance increase.\r
930   * Some optimizations in audio mixing code.\r
931   * Some menu changes (background added, smaller font in ROM browser, savestate loader\r
932     now can select slots).\r
933   + 1M mode DMA transfers implemented (used by FMV games like Night Trap and Sewer Shark).\r
934   + Games now can run code from WORD RAM in 1M mode (fixes Adventures of Willy Beamish).\r
935   + "Cell arrange" address mapping is now emulated (Heart of the alien).\r
936   + "Color numeric operation" is now emulated (text in Lunar 2, Silpheed intro graphics).\r
937   + "Better sync" option added (prevents some games from hanging).\r
938 \r
939 1.14\r
940   + Region autodetection now can be customized.\r
941   * When CDDA music tracks changed, old buffer contents were incorrectly played. Fixed.\r
942   * BRAM is now automatically formatted (no need to enter BIOS menu and format any more).\r
943   * Games now can be reset, CDDA music no longer breaks after loading another ISO.\r
944   * Fixed a race condition between 920 and 940 which sometimes caused CDDA music not to play.\r
945   + Savestates implemented for Sega/Mega CD.\r
946   + PCM sound added.\r
947   * Some mixer code rewritten in asm. 22kHz and 11kHz sound rates are now supported in\r
948     Mega CD mode (but mp3s must still be 44kHz stereo).\r
949   + Timer emulation added.\r
950   * CDC DMA tansfers fixed. Snatcher and probably some more games now boot.\r
951   * 2M word RAM -> VDP transfers fixed, no more corruption in Ecco and some other games.\r
952 \r
953 1.10\r
954   + GP2X: Added experimental Sega CD support.\r
955   + GP2X: Added partial gmv movie playback support.\r
956 \r
957 0.964\r
958   * GP2X: Fixed a sound buffer underflow issue on lower sample rate modes, which was\r
959           happening for NTSC games and causing sound clicks.\r
960   * GP2X: Redone key config to better support USB joysticks (now multiple joysticks\r
961           should be useable and configurable).\r
962   + GP2X: Added save confirmation option.\r
963   + GP2X: Added 940 CPU crash detection.\r
964   + ALL:  UIQ3 port added.\r
965 \r
966 0.963\r
967   * GP2X: Gamma-reset-on-entering-menu bug fixed.\r
968   * GP2X: Recompiled PicoDrive with gcc profiling option set as described here:\r
969           http://www.gp32x.com/board/index.php?showtopic=28490\r
970 \r
971 0.962\r
972   * GP2X: Fixed an issue with incorrect sounds in some games when dualcore operation\r
973           was enabled (for example punch sound in SOR).\r
974   * GP2X: Limited max volume to 90, because higher values often cause distortions.\r
975   * GP2X: Fixed a bug with lower res scaling.\r
976   * GP2X: Gamma is now reset on exit.\r
977 \r
978 0.96\r
979   * ALL:  Severely optimized MAME's YM2612 core, part of it is now rewritten in asm.\r
980   + GP2X: The YM2612's code now can be run in GP2X's ARM940T CPU, what causes large\r
981           performance increase.\r
982   * ALL:  Accurate renderers are slightly faster now.\r
983   + GP2X: Using quadruple buffering instead of doublebuffer now, also updated\r
984           framelimitter, this should eliminate some scrolling and tearing problems.\r
985   * GP2X: Fixed some flickering issues of 8bit accurate renderer.\r
986   + GP2X: craigix's RAM timings now can be enabled in the menu (see advanced options).\r
987   + GP2X: Added ability to save config for specific games only.\r
988   + GP2X: Gamma control added (using GP2X's hardware capabilities for this).\r
989   * GP2X: Volume keys are now configurable.\r
990   + GP2X: GnoStiC added USB joystick support, I made it possible to use it for\r
991           player 2 control (currently untested).\r
992   * GP2X: squidgehack is now applied through kernel module (cleaner way).\r
993 \r
994 0.95\r
995   * ALL:  Fixed a bug in sprite renderer which was causing slowdowns for some games.\r
996   + GP2X: Added command line support\r
997   + GP2X: Added optional hardware scaling for lower-res games like Shining Force.\r
998   * ALL:  Sound chips are now sampled 2 times per frame. This fixed some games which\r
999           had missing sounds (Vectorman 2 1st level, Thunder Force 3 water level,\r
1000               etc.).\r
1001   + ALL:  Added another accurate 8-bit renderer which is slightly faster and made it\r
1002           default.\r
1003 \r
1004 0.945\r
1005   + GP2X: Added frame limiter for frameskipped modes.\r
1006   * GP2X: Increased brightness a bit (unused pixel bits now also contain data).\r
1007   * GP2X: Suidgehack was not applied correctly (was applied before allocating some\r
1008           high memory and had no effect).\r
1009 \r
1010 0.94\r
1011   + Added GP2X port.\r
1012   * Improved interrupt timing, Mazin Saga and Burning Force now works.\r
1013   * Rewritten renderer code to better suit GP2X, should be faster on other\r
1014     ports too.\r
1015   + Added support for banking used by 12-in-1 and 4-in-1 ROMs (thanks Haze).\r
1016   + Added some protection device faking, used by some unlicensed games like\r
1017     Super Bubble Bobble, King of Fighters, Elf Wor, ... (thanks to Haze again)\r
1018   + Added primitive Virtua Racing SVP faking, so menus can be seen now.\r
1019 \r
1020 0.93\r
1021   * Fixed a problem with P900/P910 key configuration in FC mode.\r
1022   * Improved shadow/hilight mode emulation. Still not perfect, but should be\r
1023     enough for most games.\r
1024   + Save state slots added.\r
1025   + Region selector added.\r
1026 \r
1027 0.92\r
1028   VDP changes:\r
1029   * VDP emulation is now more accurate (fixes flickering in Chase HQ II,\r
1030     Super Hang-On and some other problems in other games).\r
1031   * HV counter emulation is now much more accurate. Fixes the Asterix games,\r
1032     line in Road Rash 3, etc.\r
1033   * Minor sprite and layer scroll masking bugs fixed.\r
1034   + Added partial interlace mode renderer (Sonic 2 vs mode)\r
1035   * Fixed a crash in both renderers when certain size window layers were used.\r
1036   + Added emulation of shadow/hilight operator sprites. Other shadow/hilight\r
1037     effects are still unemulated.\r
1038   + Sprite emulation is more accurate, sprite limit is emulated.\r
1039   + Added "accurate sprites" option, which always draws sprites in correct\r
1040     order and emulates sprite collision bit, but is significantly slower.\r
1041 \r
1042   Emulation changes:\r
1043   * Improved interrupt handling, added deferred interrupt emulation\r
1044     (Lemmings, etc).\r
1045   + Added serial EEPROM SRAM support (Wonder Boy in Monster World,\r
1046     Megaman - The Wily Wars and many EA sports games like NBA Jam).\r
1047   + Implemented ROM banking for Super Street Fighter II - The New Challengers\r
1048   * Updated to the latest version of DrZ80 core, integrated memory handlers\r
1049     in it for better performance. A noticeable performance increase, but save\r
1050         states may not work from the previous version (you can only use them with\r
1051         sound disabled in that case).\r
1052   + SRAM word read handler was using incorrect byte order, fixed.\r
1053 \r
1054   Changes in Cyclone 0.0086:\r
1055   + Added missing CHK opcode handler (used by SeaQuest DSV).\r
1056   + Added missing TAS opcode handler (Gargoyles,Bubba N Stix,...). As in real genesis,\r
1057     memory write-back phase is ignored (but can be enabled in config.h if needed).\r
1058   + Added missing NBCD and TRAPV opcode handlers.\r
1059   + Added missing addressing mode for CMP/EOR.\r
1060   + Added some minor optimizations.\r
1061   - Removed 216 handlers for 2927 opcodes which were generated for invalid addressing modes.\r
1062   + Fixed flags for ASL, NEG, NEGX, DIVU, ADDX, SUBX, ROXR.\r
1063   + Bugs fixed in MOVEP, LINK, ADDQ, DIVS handlers.\r
1064   * Undocumented flags for CHK, ABCD, SBCD and NBCD are now emulated the same way as in Musashi.\r
1065   + Added Uninitialized Interrupt emulation.\r
1066   + Altered timing for about half of opcodes to match Musashi's.\r
1067 \r
1068 0.80\r
1069   * Nearly all VDP code was rewritten in ARM asm. Gives ~10-25% performance\r
1070     increase (depends on game).\r
1071   * Optimized 32-column renderer not to render tiles offscreen, games which\r
1072     use 32-column display (like Shining Force) run ~50% faster.\r
1073   + Added new "Alternative renderer", which gives another ~30-45% performance\r
1074     increase (in addition to mentioned above), but works only with some games,\r
1075     because it is missing some features (it uses tile-based rendering\r
1076     instead of default line-based and disables H-ints).\r
1077   + Added "fit2" display mode for all FC gamers. It always uses 208x146 for\r
1078     P800 and 208x208 for all other phones.\r
1079   + Added volume control for Motorolas (experimental).\r
1080 \r
1081   VDP changes:\r
1082   + Added support for vertical window (used by Vapor Trail, Mercs, GRIND\r
1083     Stormer and others).\r
1084   + Added sprite masking (hiding), adds some speed.\r
1085   + Added preliminary H counter emulation. Comix Zone and Sonic 3D Blast\r
1086     special stage are now playable.\r
1087   + Added column based vertical scrolling (Gunstar Heroes battleship level,\r
1088     Sonic and Knuckles lava boss, etc).\r
1089 \r
1090   Emulation changes:\r
1091   + Re-added and improved Z80 faking when Z80 is disabled. Many games now can\r
1092     be played without enabling Z80 (Lost Vikings, Syndicate, etc), but some\r
1093     still need it (International Superstar Soccer Deluxe).\r
1094   * Improved ym2612 timers, Outrun music plays at correct speed, voices in\r
1095     Earthworm Jim play better, more games play sound.\r
1096   * I/O registers now remember their values (needed for Pirates! Gold)\r
1097   + Added support for 6 button pad.\r
1098 \r
1099   Changes in Cyclone 0.0083wip:\r
1100   + Added missing CHK opcode (used by SeaQuest DSV).\r
1101   + Added missing TAS opcode (Gargoyles). As in real genesis, write-back phase\r
1102     is ignored (but is enabled for other systems).\r
1103 \r
1104   Backported stuff from Snes9x:\r
1105   * Fixed Pxxx jog up/down which were not working in game.\r
1106   + Added an option to gzip save states to save space.\r
1107   + The emulator now pauses whenever it is loosing focus, so it will now pause\r
1108     when alarm/ponecall/battery low/... windows come up.\r
1109   - Removed 'pause on phonecall' feature, as it is no longer needed.\r
1110   + Video fix for asian A1000s.\r
1111 \r
1112 0.70\r
1113   * Started using tools from "Symbian GCC Improvement Project", which give\r
1114     considerable speed increase (~4fps in "center 90" mode).\r
1115   * Rewrote some drawing routines in ARM assembly (gives ~6 more fps in\r
1116     "center 90" mode).\r
1117   * Minor improvement to 0 and 180 "fit" modes. Now they look slightly better\r
1118     and are faster.\r
1119   * Minor stability improvements (emulator is less likely to crash).\r
1120   + Added some background for OSD text for better readability.\r
1121   + Added Pal/NTSC detection. This is needed for proper sound speed.\r
1122   + Implemented Reesy's DrZ80 Z80 emu. Made some changes to it with hope to make\r
1123     it faster.\r
1124   + Implemented ym2612 emu from the MAME project. Runs well but sometimes sounds\r
1125     a bit weird. Could be a little faster, so made some changes too.\r
1126   + Implemented SN76489 emu from the MAME project.\r
1127   + Added two separate sound output methods (mediaserver and cmaudiofb) with\r
1128     autodetection (needs testing).\r
1129   * Fixed VDP DMA fill emulation (as described in Charles MacDonald's docs),\r
1130     fixes Contra and some other games.\r
1131 \r
1132 0.301\r
1133   Launcher:\r
1134   * Launcher now starts emulation process from current directory,\r
1135     not from hardcoded paths.\r
1136   * Improved 'pause on call' feature, should hopefully work with Motorola phones.\r
1137 \r
1138 0.30\r
1139   Initial release.\r
1140 \r
1141 \r
1142 License\r
1143 -------\r
1144 \r
1145 This program and it's code is released under the terms of MAME license:\r
1146 \r
1147  Redistribution and use of this code or any derivative works are permitted\r
1148  provided that the following conditions are met:\r
1149 \r
1150  * Redistributions may not be sold, nor may they be used in a commercial\r
1151  product or activity.\r
1152 \r
1153  * Redistributions that are modified from the original source must include the\r
1154  complete source code, including the source code for all components used by a\r
1155  binary built from the modified sources. However, as a special exception, the\r
1156  source code distributed need not include anything that is normally distributed\r
1157  (in either source or binary form) with the major components (compiler, kernel,\r
1158  and so on) of the operating system on which the executable runs, unless that\r
1159  component itself accompanies the executable.\r
1160 \r
1161  * Redistributions must reproduce the above copyright notice, this list of\r
1162  conditions and the following disclaimer in the documentation and/or other\r
1163  materials provided with the distribution.\r
1164 \r
1165  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"\r
1166  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
1167  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
1168  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE\r
1169  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\r
1170  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\r
1171  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
1172  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
1173  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
1174  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
1175  POSSIBILITY OF SUCH DAMAGE.\r
1176 \r
1177 SEGA/Genesis/MegaDrive/SEGA-CD/Mega-CD/32X are trademarks of\r
1178 Sega Enterprises Ltd.\r
1179 \r