TMNT Emulator Beta Release 0.7 (5/4/98)
----------------------------------------

DELETE YOUR OLD TMNT.CFG BEFORE RUNNING THE EMULATOR AND CREATE A NEW ONE!!!

Wow, I'm surprised someone is actually reading this...THANK YOU!

First off:
   Since this emulator uses specific SVGA Chipset code, down to the "bare
metal" it is possible (if something goes wrong) that you may do damage to
your video card, or maybe monitor.  I am not responsible for any damage
done whatsoever to anything.  If you don't agree with this, delete the
emulator, don't use, and be quiet.

Changes since last release:
 + Now 3 different flavors, DOS, Windows using GDI and Windows using DirectX
 + Joystick support for DOS
 + Sprite vs Background Priority fixed
 + More video resolutions added
 + Made it faster
 + Sticky keys fixed
 + Sprite glitches all fixed
 + New config program
 + Default keys changed

!!! Go try out that Mame TMNT on the Beta 0.33 It's great, and has Sound !!!

Known Problems/Things to do
---------------------------
 - No Sound
 - SPEED!
 - Transparency problems in 256 color mode
 - Possibly a better palette for 256 color mode (I have to map 512 colors
   to 256, thats why its not as nice as 16 bit color mode)
 - DirectDraw version doesn't work for some reason on some computers
 - ScreenShot key only works in DOS version


1] Getting Started
==================
  1) Unzip the zip file containing the emulator and config.exe (you probably
     already did this)
  2) Make a subdirectory in the directory you put the emulator and config.exe in
     called "ROMS" (without the ").  Put all the roms into this directory. You
     won't be able to find the roms on my web page, nor get them from me (so
     DON'T EMAIL ME asking for them), search the web if you don't have them,
     but remember, it's illegal to posess the roms without owning the actual
     arcade machine. Here are the rom file names:
     TMNT.J17,TMNT.K17,TMNT.H27,TMNT.K27,TMNT.H04,TMNT.K04
     TMNT.H06,TMNT.K06,TMNT.C13,TMNT.D05,TMNT.J15,TMNT.D18
     TMNT.F19,TMNT.K15,TMNT.F7 and TMNT.G13
  3) Run config.exe (to make a tmnt.cfg file).  If you get an error running
     config.exe it's most likely because you are missing a DLL file.  DO
     NOT EMAIL me asking for these DLL files...you can easily find these on
     the web, download and put in your Windows directory.  These are not
     illegal to download, BTW.
     In config you can set up a bunch of different things...these are
     explained by clicking on the Help button in config.
  4) run the emulator (tmntdos.exe, tmntgdi.exe or tmntdd.exe)
  5) If you get an error, read through these docs CLOSELY, MAKE
     SURE YOUR NOT DOING SOMETHING WRONG!
  6) Play the game
  7) Beat the game
  8) Press ESC to exit

2] Info about the versions
==========================
   DOS Version - The DOS version is pretty much just like the old version,
except the -vesa and -svga command line options have been removed and put
in the config.  There are more video modes options available now, so if it
didn't work in the past for you, hopefully one of the new resolutions will
work.  If you still can't get the DOS version to work try the Windows
versions (the GDI version should work no matter what).  Joystick support
has been added to the DOS version only.  Currently I only support one
joystick (a future release should support more).  I haven't done much testing
with the joystick, but it worked fine for me with my Gravis Gamepad.
   GDI Version - This version should work for anyone running Windows 95
or NT.  Your Window's video mode must be set up for at least 256 colors
(preferably 16-bit color).  If you video mode is set up for 256 colors,
the emulator will run the 8-bit color version (which isn't really good
right now).  Any higher color depth will be the 16-bit color version.
There is no joystick for the GDI version.  The GDI version will run in
a window no matter what.
   DirectDraw Version - To run this version you'll need DirectX 5.0 or later
installed for your Windows.  While I've had some problems with the DirectDraw
version working for me at my computer at work (I just get a black screen), it
works just fine for me at my home computer.  The DirectDraw version only
runs in Full-Screen mode.  There is no joystick for the DirectDraw version.

3] Key Configurations
=====================

By Default the keys are set as the following:
Key     Action
ESC     Quit Game
1       Player 1 Coin
2       Player 2 Coin
3       Player 3 Coin
4       Player 4 Coin
ARROWS  Player movement (all players)
A       Player Jump (all players)
S       Player Attack (all players)
F12     ScreenShot (DOS Version Only)
CTRL F1-F10   Save State (1-10)
SHIFT F1-F10  Restore State (1-10)

You can configure any of the player movement or attack/jump keys.  However,
you can't change the non-movemnet non-attack/jump keys..so I'd recommend
configuring your movement or attack/jump keys to keys OTHER than the ones
you can't configure (duh!...)
To configure a key, run config.exe.  Press the button corresponding to what
player keys you want to configure.  Once the window displays you can click
on what key (using your mouse) you want to configure (Up,Down,Left,Right,
Jump or Attack)...after you click the button with the mouse, press the key
you want to use...the label on the button should now display the key you
just pressed. Press OK when done (make sure you press OK when exiting
config.exe or it won't save the configuration).

4] FAQ
======

It doesn't work! What do I do?
   Play around with different video modes (config.exe)...if that doesn't work
try playing in DOS only (if your running the DOS version)...if that doesn't
work try the Window's versions...the GDI version should work.

What are the sys requirements?
   Don't know really...I haven't went through the code to see all the memory
I'm using.  You definitly should have more than 8 megs...probably more than
16 megs.  As far as computer speed...I don't know what works well...I can
play ok on my P133 with 64 megs of RAM.

I don't think I have enough memory, now what?
   Add more memory to your computer

My computer is too slow!  Now what?  Will you optimize this thing?
   Eventually I will optimize it, probably will be optimized a bit for the
next release.  Try increasing the Frame Skip in config.  Also try different
video resolutions.

Can I configure my keys?
  Yup, see "Key Configurations" section.

Do you support a joystick?
  Only in the DOS version

I don't hear any sound!
  Cause there isn't any...I didn't get around to emulating it yet

Are you gonna release the source code?
   Yup, there is already a source code release for an earlier version,
I'll be preparing the source code and updating the info on my web page
soon.

5] Special Thanks
=================
   Everyone who sent me nice emails, thanking me (and just making me feel
good :P ).
   Also I'd like to thank Alex, Nicola, Neill Corlett,Kevin & my
   other co-workers, and anyone else who has steered me
   in the right direction.
   Finally, Konami, Kevin Eastman and Peter Laird

TMNT.CFG File Format
====================
Byte Offset  Size (in Bytes)    Description
-----------  ----               -----------
   0          1                  File Version (Must be 8 for this release)
   1          1                  SVGA Detection
                                        0 = Autodetect
                                        1 = VESA
                                        2 = SVGA
   2          1                  SVGA Chipset value (only used if above is 2)
   3          1                  DIP 1
   4          1                  DIP 2
   5          1                  DIP 3
   6          1                  FullScreen/Windowed (FullScreen=0 Windowed=1)
   7          1                  Joystick Info
                                        0 = None
                                        1 = Player 1
                                        2 = Player 2
                                        3 = Player 3
                                        4 = Player 4
   8          1                  Color Depth (8=8bit 16=16 Bit)
   9          1                  Video Mode
                                        0 = 320x200
                                        1 = 320x400
                                        2 = 320x240
                                        3 = 320x480
                                        4 = 640x400
                                        5 = 640x480
                                        6 = 800x600
                                        7 = 1024x768
                                        8 = 1280x1024

                    (Note, Keys use my virtual key codes, which I don't
                    feel like typing all out)
  10          1                  P1 Up
  11          1                  P1 Right
  12          1                  P1 Down   
  13          1                  P1 Left
  14          1                  P1 Jump
  15          1                  P1 Attack
  16          1                  P2 Up
  17          1                  P2 Right
  18          1                  P2 Down   
  19          1                  P2 Left
  20          1                  P2 Jump
  21          1                  P2 Attack
  22          1                  P3 Up
  23          1                  P3 Right
  24          1                  P3 Down   
  25          1                  P3 Left
  26          1                  P3 Jump
  27          1                  P3 Attack
  28          1                  P4 Up
  29          1                  P4 Right
  30          1                  P4 Down   
  31          1                  P4 Left
  32          1                  P4 Jump
  33          1                  P4 Attack
  34          1                  Cache Info
                                   Bit 0 = Enable Page 0
                                   Bit 1 = Enable Page 1
                                   Bit 2 = Enable Page 2
  35          1                  Cache Max Age
  36          2                  Cache Size
  38          1                  Frame Skip


SVGA ChipSet Codes:
===================
code SVGA chipset                 notes
---- ------------                 -----
1    VESA                         same as specifing -vesa on the command line
2    Acer Labs 3100 series
3    Ahead V5000A                 Can't do 16 bit color modes
4    Ahead V5000B                 Can't do 16 bit color modes
5    Alliance ProMotion 3210/6410
6    Alliance ProMotion 6422/AT24
7    ARK Logic 1000/2000
8    ATI 18800                    Can't do 16 bit color modes
9    ATI 18800-1                  Can't do 16 bit color modes
10   ATI 28800/38800
11   ATI mach32 (68800)
12   ATI mach64 CX/GX
13   ATI mach64 CT/ET/GT/VT
14   Avance Logic 2101
15   Avance Logic 2201
16   Avance Logic 2228/2301
17   C&T 82c450/453              Can't do 16 bit color modes
18   C&T 82c451/455/456/457      Can't do 16 bit color modes
19   C&T 82c452                  Can't do 16 bit color modes
20   C&T 64000 series
21   C&T 65510/65520/65525/65530 Can't do 16 bit color modes
22   C&T 65535
23   C&T 65540/65545
24   C&T 65548
25   C&T 65550 series
26   Cirrus Logic 5402           Can't do 16 bit color modes
27   Cirrus Logic 5420
28   Cirrus Logic 5422/5424/5426/5428/5429
29   Cirrus Logic 5430/5440 series
30   Cirrus Logic 6200 series    Can't do 16 bit color modes
31   Cirrus Logic 6245           Can't do 16 bit color modes
32   Cirrus Logic 6400 series    Can't do 16 bit color modes
33   Cirrus Logic 7540 series    Can't do 16 bit color modes
34   Diamond Viper with Weitek P9000
35   Genoa 6000 series           Can't do 16 bit color modes
36   HMC 86304/86314             Can't do 16 bit color modes
37   Matrox MGA 64               Can't do 16 bit color modes
38   Matrox MGA 1064SG/2064W
39   NCR 77C21/77C22             Can't do 16 bit color modes
40   NCR 77C22E
41   NCR 77C32BLT
42   Oak OTI-067                 Can't do 16 bit color modes
43   Oak OTI-077                 Can't do 16 bit color modes
44   Oak OTI-087
45   Oak 64000 series
46   Paradise PVGA1a             Can't do 16 bit color modes
47   Paradise WD90C00/WD90C10    Can't do 16 bit color modes
48   Paradise WD90C11/WD90C30    Can't do 16 bit color modes
49   Paradise WD90C24/WD90C26
50   Paradise WD90C31            Can't do 16 bit color modes
51   Paradise WD90C33
52   Paradise WD9710
53   Realtek 3100 series
54   S3 86C801/86C805
55   S3 86C911/86C924            Can't do 16 bit color modes
56   S3 86C928
57   S3 Vision/Trio/ViRGE series
58   Sierra 15064 (Falcon 64)
59   SiS 6200 series
60   Trident 8800                Can't do 16 bit color modes
61   Trident 8900/8900B/8900C/9000
62   Trident 8900CL/8900D/9000C
63   Trident 9200/9400/9600 series
64   Tseng ET3000                Can't do 16 bit color modes
65   Tseng ET4000AX
66   Tseng ET4000/W32
67   Tseng ET6000
68   UMC 85C408/85C418
69   Video7                      Can't do 16 bit color modes
70   Weitek 5186/5286/P9100      Can't do 16 bit color modes

