#--StuntsCarSwapper--#

Version 0.1; revision 1

INTRODUCTION

This program was created to answer the need for a convenient tool to manage
installed cars in Stunts. The game will only use 32 cars at a time; and, given
the ever growing rate of creation of new cars, it is very easy to overtake this
limit. StuntsCarSwapper (from now on simply SCS) works by transfering car files
to and/or from the current folder to a "backup" directory.

LAUNCHING THE PROGRAM

SCS is a Java program; and therefore you will need to have Java installed or
otherwise available in your machine (version 1.5 minimum). In case you do not
have it, it can be easily downloaded and installed from
http://www.oracle.com/technetwork/java/javase/downloads/index.html
(look for "Download JRE"). The program is
meant to be launched with the scripts provided (SCS.bat for Windows and SCS.sh
for Linux). All they do is invoke Java (assumed to be in the system's executable
path) from your system's install. In case they fail to work due to not finding
the Java installation it means that you have to either install Java or add it to
the executable path. If you know where Java is installed (typically Program
Files/Java/(...) in Windows) another possibility is to replace the 'java'
command on the script with the full path to the executable.

BASIC USAGE

On startup, SCS will scan the folder in which it is located for CAR*.RES files
(typically, you'll want to put the program inside your Stunts folder).
If any files are found, they will be included on the left-side list of "Active
cars". Additionally, a subdirectory named scs_bk will be created or, if it
already exists, scanned for the backup/inactive cars, which will be included in
the right-side list. Cars can then be exchanged from one list to another using
the "Transfer cars to backup" and "Add cars from backup" buttons, by selecting
one or more cars (use Shift-click or Ctrl-click) and then using the appropriate
buttons. Transfering a car will involve the CAR*.RES file as well as any
associated graphical files (that is, any ST*.P3S/3SH and STDA/STDB*.PVS/VSH
sharing the four-letter ID). The number of cars in both the main directory and
the backup one are indicated above the list. The active directory can be changed
from the original one at any time through the "Switch directory..." button.

TIPS AND CAVEATS

* The "Make safety copy of cars" option allows you to copy all cars on the
active cars list to a subdirectory scs_safe, which will be created if not
existing.

* On the topic of filename capitalization, SCS will recognize the most common
styles for the .RES file when identifying cars (prefixes CAR, car and Car;
suffixes .RES and .res). Once a CAR*.RES is identified, the program will ignore
capitalization, so there is no need to worry about files such as StzPMI.pvs
being ignored during transfers.

* Although moving car files away from the folders in use while SCS is running is
not a good idea, trying to transfer a car whose .RES was removed after the car
lists being generated will have no effect other than updating the lists to
remove the ghost entry (but *not* any remaining graphical files).

* In case there is a need for rescanning the current directory (for "hot-plug"
car installations, for instance) reloading it with the "Switch directory"
command will do the trick.

LICENSING

SCS is formally released under the terms of the GPL v3 (see COPYING file), and
is meant for the benefit of the Stunts community - so please be my guest: hack
and redistribute it to your heart's desire.

RELEASE NOTES

v0.1, r1 (02-Oct-2010): Initial release

CONTACT

Feedback is always appreciated! For bugs and suggestions, look for me (Duplode)
at forum.stunts.hu, or mail me at scrstunts_AT_yahoo.com.br (replace _AT_ with
the usual sign).

---

See you on the scoreboards,

Duplode
Southern Cross Racing Developments
02-Oct-2010
