Documentation for VPCE v0.3 (Virtual PC-Engine) 
===============================================

Starting:
        vpce [<filename>] [parameters]

filename:
        Without a filename VPCE tries to load "CART.PCE".

parameters:
        -us : country protection set to US (default, and mostly US-games
              check it !) (set it for "military madness")
        -jp : country protection set to Japan (set it for "nectaris")
        -swap: swap bitorder, for images, that have been dumped with the
                "wrong" order.
        -run : bypass the debugger and run the game [default]
        -debug: run the debugger 

        -bench n : render n frames and exit
        -frameskip n : skip n frames between updates

        -joypad: enable analog ibm-joystick/pad
        -nojoypad: disable analog ibm-joystick/pad

        -bm <name>: filename for backup-memory
        >> Attention: The default filename for the backup-memory changed <<
        >> from "bram.bin" to "backup.ram" !                             <<

        -sound: enable sound 
        -nosound: disable sound [default]
        >> The MS-DOS version has no sound-driver, yet. It will be added    <<
        >> to version v0.4. If you enable sound, a file called "output.snd" <<
        >> will be written into the current directory, it's raw audio,      <<
        >> stereo, 8-bit, 22050 Hz, unsigned.                               <<

(Only in the unix-version:)
        -townspad: enable the FM-Towns joypad
        -notownspad: disable the FM-Towns joypad [default]

        -xshm: enable X-shared memory extensions [default]
        -noxshm: disable X-shared memory extensions
(Only in the msdos-version:)
        -videomode 0..2
                0: 320x200
                1: 256x240
                2: 256x256

The msdos version needs the cwspmi protected-mode server, if it isn't
started from windows. Look at www.delorie.com for the cwsdpmi package,
or look, if another of your programs has the necessary file. It's called
"CWSDPMI.EXE". Just copy it into the same directory as vpce.exe, or copy
it into one of the directorys in the PATH.

game keys:
ESC:                    quit the emulator, or drop back to the debugger in
                        debug-mode
Joypad/Joystick/Cursor: Move
S                       Save screenshot to disk

Ctrl/Shift/Space/Return: I, II, select, run

Debug-Mode

Press 'R' to start emulation ! The game is controlled by a 4-button analog
joypad or the keyboard.


debugger keys:

Keys:
ESC     exit
TAB     change display-mode (disassembly, memory, VRAM)
DEL     nop opcode at cursor position
X       place a 'RET' at cursor position
Y       place a 'RTI' at cursor position
T       single-step current opcode
R       start program
S       step over current opcode 
H       go to cursor position
V       browse VRAM:
        1       select bg-mode 
        2       select sprite-mode 
        3       select map-mode 
        4       select map-mode, but don't decode the palette information
        +/- = selects the 16-color palette to use */
        up/down/left/right: move

M       save virtual "map". Can be handy for creating maps for RPGs ...
        (This function saves only the background, without sprites)
P       save screenshot

The keys 'M' and 'P' do now prompt for a filename.

1       trigger irq at $FFFC
2       trigger irq at $FFFA
3       trigger irq at $FFF8
4       trigger irq at $FFF6
up/down/left/right: move

History:
Version VPCE_PRE
- first version (16-Bit real-mode)
- some Hu6502 instructions
- visual debugger/disassembler

Version VPCE PRE-2
- 32-Bit version
- integrated most of the memory/cpu stuff
- removed MSCDEX-driver, CD-ROM stuff temporarily disabled !
- loads HuCards
- added lot's of debugger functions

Version VPCE PRE-3
- graphics, sprite, line-by-line update
- (experimental GUS-driver, removed for this preview)

Version VPCE PRE-4
- fixed a few bugs in CPU-emulation. Thanks go to David Shadoff for
  releasing his code !
- completely rewrote the sprite-clipping method.
- rewrote the joypad code slightly.

Version VPCE v0.1
- rewrote the video-engine
- fixed some bugs and added some new...
- rewrote timing and irq

Version VPCE v0.2
- rewrote the sprite-engine: sprite/sprite and sprite/background priority
  seems to work correctly.
- fixed some bugs and added some new...
- modified timing. Bomberman works a little better ...

Version VPCE v0.3
- added new video-modes: 256x256, 256x240
- fixed a stupid bug in vram-emulation. Thanks go to Paul Clifford for
  reporting it !
- fixed some bugs all over the place
- improved timing
- keyboard control

			Jens Ch. Restemeier

Many thanks go to ...
- David Shadoff
- David Woodford
- David Michel
- Joe LoCicero,IV
- The Riddler
- Videoman
- Stephane DUBON

... for their great help !

And a very lot of thanks go to:
- Edward Massey for the Win-32 version
- Jonathan Lane for the MacOS/BeOS version
- Paul Clifford for the RiscOS version, and for finding new information
- Osamu KURATI for the Unix/X version
- Steven Fuller for the Linux/SVGAlib version

------------------------------------------------------------------------------
e-mail: Jens Ch. Restemeier <jchrr@hrz.uni-bielefeld.de>

------------------------------------------------------------------------------
IMPORTANT ! IMPORTANT ! IMPORTANT ! IMPORTANT ! IMPORTANT ! IMPORTANT ! IMPORT
------------------------------------------------------------------------------
Use VPCE at your own risk.  There is no warranty for the  program  of any kind.
I don't  take  responsibility  for  any  damage  caused by the program, either
direct or indirect, physical or psychical,  to your hardware, software or soul.
------------------------------------------------------------------------------

VPCE/MSDOS v0.2 Copyright 1997 Jens Ch. Restemeier
VPCE/WIN32 v0.15 additional code Copyright 1997 Edward Massey
VPCE/MacOS v0.2 additional code Copyright 1997 Jonathan Lane
VPCE/RiscOS v0.2 additional code Copyright 1997 Paul Clifford
VPCE/Unix v0.2 additional code Copyright 1997 Osamu KURATI and Steven Fuller

None of the above authors is affiliated with NEC or Hudson nor advocate the
 piracy of PC-Engine games !

VPCE is freeware and can be distributed freely as long as it is not modified
 and ROMs are not packaged with the program !

"NEC", "PC-Engine" and "Turbo Grafx 16" are trademarks of NEC and Hudson.

   --- If you do not agree with these terms delete this software now ! ---
