Pedestrian Editor version 0.03, by Mark Hatton, hatty@netlink.net.au
====================================================================
Consider this version to be anoter pre-release/beta.  Please report ANY bugs
to hatty@netlink.net.au.  I'm also open to any suggestions (except for people
suggesting that I should make a Windows version, because I'm already working
on it!  And it's now nearly finished!)


Contents:
=========
Introduction
Using the Program
Easy Import Tutorial
Key List
Importing
CD Limitations
Command-Line Paramaters
Contacting the Author
Recommendations/Bug Fixes/Work-arounds:
Version History

Introduction:
=============
This program was based on my own PIX View program, with a few new features
that currently, no other programs support.  They include:
        - Speed.  This program is FAIRLY fast (speed may improve more in later
          versions).
        - Import Option.  Now you can replace the Carmageddon Pedestrians with
          your own hand-drawn or scanned images.  Some limitations do apply to
          this.  Make sure that the GIF that you are importing from uses the
          correct palette.  Other limitations include problems with "Minimum"
          installations.
        - Nice Menus.  This program is very easy to use.  Move the cursor
          around with the arrow keys.  An abbreviated list of keys is on the
          screen at all times.  This TXT file also contains an extended list
          of the keys available in the program.

This text file will be improved in later versions.


Using the Program:
==================
 Pedestrian Editor's interface is fairly basic, but very easy to use.  There
are two main windows, the Pedestrian Name window and the Individual Pedestrian
Frame window.  To scroll through the contents of the selected window, use the
up and down arrow keys.  To switch between the two windows, use the left and
right arrow keys.  To view the currently selected frame, press the ENTER key.

 Once the image has been displayed (and it is still on the screen), use the up
and down arrow keys to scroll through each frame of the animation.  To stop
looking at the image press any key (other than up/down) to return to the main
image-selection screen.

 To Export the currently selected frame, press the E key.  The image will be
displayed and then the program will return you to the image-selection screen.
A message down the bottom of the screen will be displayed, telling you the
filename that the image was exported to.  Pedestrian editor will always export
the image to BMP files.

 To Import a new image over the currently selected fame, press the I key.
Currently, the only image format that this program supports is the GIF format.
Future versions will support both BMP and GIF importing/Exporting images.
I reccomend that you use a program such as Graphics Workshop to convert the
images into GIF Format.  Read the "Importing" section for more information.

 To Export all of the frames for the currently selected pedestrian, press
Ctrl+E together.  The program will then proceed to display all of the frames
for the current pedestrian, and export them to BMP files.

 To Import all of the frames for the currently selected pedestrian, press
Ctrl+I together.  The program will then search for all 


Easy Import Tutorial
====================
Well, Importin is currently quite hard to do, here is a simple turorial to
help you out!

1) Export the images that you want to edit (press E key, or Ctrl+E to export
   all of the frames for the currently selected Pedestrian)

2) Go into your favourite BMP editor (Paint Shop Pro's good) and edit/import
   however you want... but there are currently two limitations:
   1) You cannot change the BMP to 24-bit colour, or change the palette.
   2) You cannot change the dimensions of the image (height or width)

3) Save the BMP file as a GIF file (this will not be necessary in later
   versions), but keep the same filename...
   e.g. if it was ZIMBAK.BMP, save it as ZIMBAK.GIF

4) Load up Pedestrian Editor, select the pedestrian that you have changed the
  graphics for and press the I key (Or Ctrl+I to replace ALL of the frames for
  the currently selected pedestrian).

5) If everything went okay, load up Carmageddon, and voila; your NEW
   pedestrian is now in the game!


Key List:
=========
Below is a list of the keyboard commands available at the image-selection
screen:

Up/Down:  Scroll through the items in the currently selected window.
Left/Right:  Switch between the Pedestrian Name and Individual Frame windows.
Home/End:  Use these keys to get to the start/end of the current window.
Enter:  View the currently selected frame.

E:  Export the currently selected frame
I:  Import a BMP file to replace the currently selected frame.
R:  Restore from BAK file (a BAK file is always created when you use the
    Import function).  This will restore the PIX file to what it was before
    you edited it.  Note: ALL frames of the selected pedestrian are restored.

Ctrl-E:  Export ALL of the frames for the currently selected pedestrian.
Ctrl-I:  Import BMPs to replace all of the frames for the currently selected
         pedestrian.
Escape:  Quit Pedestrian Editor.


Importing:
==========
Before you import, a backup of the original PIX file is always created, so
your original Carmageddon files should stay in tact.  Use the restore option
to re-load your original PIX file.  If you find that a major problem has
occured, copy the matching PIX file from your Carmageddon CD into the
DATA\PIXELMAP directory.

When importing, PedEdit will use the file that has the same sub-name as the
currently selected frame.  For example if you have the granny selected, and
the sub-frame ZIMBAK.PIX selected, PedEdit will look for the file ZIMBAK.GIF.
If it can't find the file, an error message will be reported, but the PIX file
should not be altered in any way.

A major limitaion with Carmageddon seems to be that you cannot change the SIZE
of any frame of the animation.  So if the original frame of ZIMBAK is 72x104
pixels (width x height) then the file that you import must also be this size.
PedEdit does not check the size of the file to import until it is too late!
I recommend that you press the R key to restore the original file if you get
the error message "[FILE] Differs in size from the original PIX file".


CD Limitations:
===============
If you used the "MINIMUM" install when you installed Carmageddon (20 meg), or
the "MEDIUM" install (50 meg) you will experience problems.  The way to fix
this is to type PEDEDIT -DIR -CD.  This will ask you the path of Carmageddon
and your CD-ROM drive.  The program will then proceed to copy all of the
necessary files to your hard disk (from your Carmageddon CD).  This will
require around 3 megabytes of disk space free.  You only have to type PEDEDIT
-DIR -CD ONCE!!!  After this, just run the program by typing PEDEDIT.


Command-Line Parameters:
========================
-DIR    Use this switch to re-enter the directory where Carmageddon can be
        found.  You will be prompted to enter the directory.

-CD     Use this switch with -DIR if you are using a minimum install (20 meg)
        or medium install (50 meg)).  This option will copy all of the files
        from your CD-ROM drive.


Contacting the Author:
======================
I, Mark Hatton, can be contacted via E-Mail at: hatty@netlink.net.au
More information about this program can be found at http://www.carmageddon.com
and technical information can be found on my programming page at this address.


Recommendations/Bug Fixes/Work-arounds:
=======================================
*** Load SMARTDRV before you run this program!  It will DRAMATICALLY improve
    the loading time (Type SMARTDRV in DOS).

*** If you only have the disk space for MINIMUM install, you must tell the
    program that your Carmageddon directory is D:\ (or whatever your CD-ROM
    drive letter is, might be E:\, or F:\, through to Z:\).  You MUST also use
    the switch -CD, so that the program will run in the CD version.

*** This program has only been tested with the Australian version of the game
    so far.  Any problems might relate to your country's version of the game.
    "Blood" patches may not work correctly with this program, and Warez
    versions are illegal anyway!  This program DOES NOT support the German
    version of Carmageddon (it uses totally different graphics files).  I
    might decide to add support for this later on (if enough people request
    it!)

*** If anything EVER goes wrong with the program, pressing the R key is always
    a good thing to do (restores the original image).  If Restore does NOT fix
    the image then you must copy the referring file from the Carmageddon CD
    (files are kept in the DATA\PIXELMAP directory, and are always 3 characters
    long, i.e. the granny is ZIM.PIX).

*** Occasionally, some images might not display properly in Carmageddon.  You
    will have to wait for a newer version if this happens to you on a frequent
    basis - Sorry!

*** If you get an error message (when you goto start a race in Carmageddon),
    something probably went wrong somewhere in PedEdit.  Try restoring the
    original file and then re-importing your own image.  If this happens on a
    regular basis, then E-Mail me.

*** There should not be any legal problems if you distribute your own PIX
    files.  I cannot be held responsible if you get in legal trouble for
    distributing these files!  I will be contacting SCi shortly, regarding
    this issue.


Version History:
================
Version 0.01:
        First release
        Many Bugs.

Version 0.02:
        MANY BUGS FIXED!
        Import now works properly.
        -CD now copies the files from your CD (allows you to import)
        Heaps of other stuff!

Version 0.03:
        MORE Bugs fixed!
        "Some Pedestrians looking stretched to the right" bug fixed!
           (Which means that ALL Pedestrians can now be used for importing)
        Loading time is now faster (but still needs work!)
        3 more pedestrians found (although one is a duplicate)
        Should be more reliable... maybe!

The following might be added to future versions:
        BMP Import Option (Should be in version 1.00)
        GIF Export Option
        Bug Fixes

        I have nearly finished PIX Editor for Windows!  A huge program with
more options than anything else that I've ever made :), Including:

Import BMP, Export BMP, Importing/Exporting frame sets, Zoom, Gamma Correction,
Carmageddon Search (that will find your Carmageddon directory for you!),
Images stretching option to fit the PIX file, Can launch your default BMP
editor (might be removed due to many bugs), and more!

E-Mail hatty@netlink.net.au if there is anything else that you'd like me to
add to this program.
