 ----------------------------------------------------------------------------
 tgemu for windows                     NEC PC-Engine / TurboGrafx-16 emulator
 ----------------------------------------------------------------------------

 Version 0.1/wa

 based on the original dos version
 by Charles MacDonald

 Windows port
 by Pascal Bosquet
 
 Table of contents
 ~~~~~~~~~~~~~~~~~
 1. What's new
 2. Controls
 3. Using the command line
 4. Source code
 5. What's missing
 6. Assistance needed
 7. Acknowledgements
 8. Contact
 9. Legal

 What's new
 ~~~~~~~~~~
 - Initial release

 Controls
 ~~~~~~~~
 Arrow keys     -   1P directional pad
 A, S, D, F     -   1P Button II, Button I, RUN, SELECT
 F1-F4          -   Set frameskip level (1-4)
 F10            -   Toggle VSync polling.
 F11            -   Toggle speed throttling.

 If you need to type more than 128 characters on the command line, you
 can either put options in a text file and add '@file.txt' to the
 command line, or put the options in a file called 'tgemuw.cfg'. In either
 case, you must put one option on each line.

 Here is a list of valid options:

 -blur <on|off>      	 Enable blur effect (16-bit color only)
 -scale <on|off>     	 Scale display to width of screen
 -vsync <on|off>     	 Enable vsync polling
 -throttle <on|off>  	 Enable speed throttling
 -skip <n>           	 Specify frame skip level (1=no frames skipped)
 -sound <on|off>     	 Enable sound output
 -sndrate <n>        	 Specify sound sample rate (8000-44100)
 -joy <s>            	 Select joystick driver (auto)
 -usa <yes|no>       	 Enable TurboGrafx-16 system detection

 windows specific options

 -joy1 <n>               specify the joypad number to use for P1
 -joy1_btn1 <n>          specify the button number for the  1 button of P1
 -joy1_btn2 <n>          specify the button number for the  2 button of P1
 -joy1_btn3 <n>          specify the button number for the  3 button of P1
 -joy1_btn4 <n>          specify the button number for the  4 button of P1
 -joy1_btn5 <n>          specify the button number for the  5 button of P1
 -joy1_btn6 <n>          specify the button number for the  6 button of P1
 -joy1_btn_run    <n>    specify the button number for the  RUN    button of P1
 -joy1_btn_select <n>    specify the button number for the  SELECT button of P1
 -winsize <n>            specify the size of the windows (1,2,3)
 -videomem <on-off>      enable use of video memory 
                         (can be speedier, thanks to final burn for the idea www.finalburn.com:)
 -winx <n>               windows x position
 -winy <n>               windows y position
 -rompath <dir>          specify the path of the last opened rom 

 tgemu will generate a file called 'pce.brm' for games that try to
 access the backup RAM to store game data. Currently only one save
 file is available for all games to use.

 What's missing
 ~~~~~~~~~~~~~~
 - Sound stops in some games.
 - The VDC and CPU emulation may need improvement
 - Display rendering could be faster
 - Sprite overflow and collision interrupt emulation
 - Sprite to sprite and sprite to background priority
 - Sound emulation needs a lot of work
 - Multitap, mouse, 3 and 6 button gamepad emulation
 - Games with extra hardware like Tennokoe Bank, SF2:CE'
 - CD-ROM support
 - Don't work under Windows NT
 - 15 BPP not tested
 
 Assistance needed
 ~~~~~~~~~~~~~~~~~
 I'm interested (Charles McDonald) in obtaining a PC-Engine backup unit like the Magic
 Griffon (or similiar) and a copy of the Develo Book.

 Has anyone made homebrewn development hardware using EPROMs or an
 EPROM emulator? I'd like to hear more about it and what's involved.

 Are there any HuCard games that use the 3-button pad and/or mouse
 exclusively?

 Acknowledgements
 ~~~~~~~~~~~~~~~~
 - Bryan McPhail for the H6280 CPU emulation.
 - Cafe Noir for the Develo Book information.
 - Carlos Hasan for SEAL.
 - Chris MacDonald for translating documents and support.
 - Contributors to the tghack-list.
 - Contributors to the TG-Internals website.
 - Cowering for GoodPCE and related utilities.
 - Dave for DGEN, which I based the 16-bit blurring code on.
 - David Michel for the Magic Kit and Magic Engine.
 - David Shadoff for TGSIM and his help with the MESS PCE driver.
 - Emanuel Schleussinger for the VDC documentation.
 - Gilles Vollant for the unzip code.
 - Jean-loup Gailly and Mark Adler for ZLIB.
 - MAME for the SEAL interface code.
 - Paul Clifford for the excellent PSG documentation.
 - Richard Bannister for the Macintosh port, code, and advice.
 - The authors of the PNG specification for 8-bit palette setup ideas.

 Contact
 ~~~~~~~

 Please take the following in mind before you e-mail us :

 - If you don't like this program, don't use it.
 - I will not send you game images.
 - don't hassle Charles for any troubles with the windows port

 Charles MacDonald
 E-mail: cgfm2@hotmail.com
 WWW: http://cgfm2.emuviews.com

 Pascal Bosquet
 E-mail: pastorama@hotmail.com
 WWW: http://users.swing.be/neozeed/tgemuw

 Legal
 ~~~~~
 The source code is distributed under the terms of the GNU General Public
 License.

 The SEAL interface code is taken from the MAME project, and terms of it's
 use are covered under the MAME license. (http://www.mame.net)

 The blur code is based on the 'CTV' sources from Dave's DGen emulator.
 (http://www.dtmnt.com)

