----------------------------------------------------------------------
                  SHIPS 98 [version 2.00.008]
----------------------------------------------------------------------
By Maurizio Benvenuti
Copyright 1997-2000, All rights reserved
----------------------------------------------------------------------

 Contents
 =========
 1. Introduction
 2. Installation
 3. Using Ships 98
 4. Modify a ship list
 5. The checksum
 6. The Ships98.dat file
 7. Questions, bug reports or suggestions
 8. Thanks
 9. Final notes


1. Introduction
===============
This program allow you to view and modify all of ship list
you're using in yours VGAP Games.

The term "ship list" refers to the collection of data files that
define the hulls, weapons and engines. In few words the five
data files used by Ships 98 are a ship list.
For a new ship list to work correctly the players AND the host
MUST be using the SAME ship list files. A new ship list will 
not work if only the players (or host) use it.
It is possible to modify the ship list mid-game, but it is not
recommended. The players and host must update their ship list
files on the SAME turn. If the host runs with a different ship
list there will be severe problems for the players the following
turn.


2. Installation
================
Ships 98 doesn't need installing, you can put it anywhere you like.
Remember: the three files in this distribution must reside in the
          same folder.

Ships98 require only the path to these five files:

HULLSPEC.DAT : This file contains the data for the 105 hull designs.
               The data stored includes minerals, cargo room and fuel
               tank size, as well as the number of crew, weapons and
               engines.

TORPSPEC.DAT : This file holds all the data for the torpedo tubes.
               There are 10 types of torpedo tubes. The data stored
               includes how much a torpedo of a particular type costs.

BEAMSPEC.DAT : This file holds all the data for the beam weapons.
               There are 10 types of beam weapons.

ENGSPEC.DAT  : This file holds all the data for the engines.
               There are 9 types of engine. The data stored includes
               how much fuel each engine uses at each warp setting.

TRUEHULL.DAT : This file holds all the information Planets needs to
               decide which ships each race can build. Each race
               gets 20 hull slots, but all 20 slots don't have to be
               used. The slots are used to store the numbers of the
               hull designs that the race can build.

These files come with all distributions of VGA Planets. You will
find them in your VGA Planets main directory. You should make a
backup of these files and keep it safe in case they become corrupted.


3. Using Ships 98
==================
When Ships 98 starts it loads the current ship list from the
specified folder. You can start Ships 98 inserting a path from
the command line (ie: SHIPS98 c:\planets).
If one the five files required is missing in the path inserted,
Ships 98 will show the name of the missing file and will ask a
new path.

If found, the HCONFIG.HST file will be loaded, as well as the RACE.NM
file. If RACE.NM file is not found, the standard races names will be
used instead. Ships 98 also search for the RESOURCE.PLN file (first
in the specified path and then in the current folder). If this file
is not found Ships 98 will be unable to display the hull images.

Ships 98, after loading fase, displays four tabs:
Hulls, Engines, Beam weapons and Torp launchers

Click the "Hulls" tab or press ALT+H to view the hulls data.
 The main frame shows the hull picture and specs. Use the small
  arrow buttons or the Left/Right arrow keys to browse the hulls
  list.
 The "Project available to" frame shows you which races can build
  the current hull. Right click on a race name to pop up a menu
  containing the current hulls list for the selected race, click
  one hull name to view its data.
 The "Special abilities - Host 3.22" frame shows the abilities
  given by Host 3.22 to the selected hull. If HCONFIG.HST file
  has been loaded and a special ability is active, a check mark
  will be showed in the special ability checkbox.

Click the "Engines" tab or press ALT+E to view the engines data.
 The main frame shows the engine specs. Use the small arrow buttons
  or the Left/Right arrow keys to browse the engines list.
 The graph on right display graphically the fuel consumption specs
  for the current engine.

Click the "Beam weapons" tab or press ALT+B to view the beam
weapons data.
 The main frame shows the beam specs. Use the small arrow buttons
  or the Left/Right arrow keys to browse the beams list.
 The graph on right display the smash and kill powers for the
  current beam.

Click the "Torp launchers" tab or press ALT+T to view the torpedo
launchers data.
 The main frame shows the torp launchers specs. Use the small arrow
  or the Left/Right arrow keys buttons to browse the torp launchers
  list.
 The graph on right display the smash and kill power specs for the
  current torpedo.

Ships 98 also displays a menu bar:
File, Options and ? (Help).

Click on menu "File" or press ALT+F to:
 * Open a ship list.
 * Save the current ship list, if modified.
 * Save the current ship list, if modified, in a different folder.
 * Export the current hulls list in a text file.
 * Calculate the current checksum.
   (See also the "The checksum" section)
 * Exit Ships 98.
   This option has a shortcut from the main window: ALT+X

 Note: if the current ship list has been modified and you select
       "Open..." or "Exit", Ships 98 advises you of the changes
       and asks to save the ship list.

Click on menu "Options" or press ALT+O to:
 * View a building cost preview of the selected hull.
 * View the extra abilities of the selected hull. (See also the
   "The Ships98.dat file" section)
 * Modify the current object (hull, engine, beam or torpedoes).
   (See also the "Modify a ship list" section)
 * Assigne the current hull to a race.
   This option has a shortcut from the main window: ALT+P

Click on menu "?" or press ALT+? to:
 * View this help.
 * View the copyright info.


4. Modify a ship list
======================
The four Modify dialog (Hulls, Engines, Beam weapons and Torp
launchers) works at the same mode.
Each modify dialog presents:
  * a client-area to show the current data.
  * two small buttons in the title bar to browse objects.
    (You may use also Left/Right arrow keys)
  * an "OK" button to confirm the changes and close dialog

Browse the object specs using Up/Down arrow keys and press
Insert key to change the selected spec.
Press "ESC" to cancel the changes and close dialog

Note: the Modify Hull dialog displays the current hull image,
      has two buttons to browse the images list (you may use
      also Page-Up/Page-Down keys) and has clipboard functions:
       * use CTRL+INS to copy the current hull in the clipboard
       * use SHIFT+INS to past the clipboard in the current hull
       * use ALT+INS to swap the clipboard with the current hull


5. The checksum
================
When Planets loads the ship list data it performs a checksum
calculation on the files. If the checksum is wrong then Planets
will assume the data files have been tampered with.
Ships 98 automatically fixes the checksum of the ship list when
it is saved.
Under certain conditions Ships 98 may be unable to correct the
checksum. Ships 98 will advise you of this should it happen.
If Ships 98 reports the checksum is too high to correct then try
converting hull, weapon and/or engine names to uppercase.
Reducing the length of the names will also help.
If Ships 98 reports the checksum is too low to correct then try
doing the opposite. In addition increasing values lower than 255
to 255 will help.


6. The Ships98.dat file
========================
This file is used to store and show additional abilities given by
addons used in your VGAP games.

This file must have a fixed header :   [Abilities]

then follow text lines structured as :

nhull = 1st extra ability | 2nd extra ability | ecc...
   (| is the pipeline character)

---Example:-------------------

[Abilities]

22=Megalaser|Criogenic cells


------< End of Extract >------

Note: Ships 98 will upgrade automatically old Ships97.dat files to
      new file format.


7. Questions, bug reports or suggestions
=========================================
This program has been given a good amount of testing. I am pretty
sure it's bug-free, but if you find any, please e-mail me.
If you have any questions, please e-mail me at zeross.mauri@tin.it


8. Thanks
==========
To Tim Wisseman for his help and for VGA Planets.
VGA Planets official site is http://www.wilmington.net/vgaplanets


9. Final notes
===============
Check the Ships 98 web page for latest informations:
http://www.geocities.com/TimesSquare/Battlefield/5544/ships.html

This software may be used at no charge and may be distributed
freely but must always be distributed unmodified and as a unit
with all files present, including this file.

You are NOT allowed to decompile, disassemble or modify by no
means the software contained in this distribution.

The software and documentation in this distribution are provided
"as is" without express or implied warranty including, but not
limited to, the implied warranties of merchantability and fitness
for a particular purpose.
In no event will the author of this software be liable for direct,
incidental or consequential damages of any kind, even if the author
have been advised of the possibility of such damages. 

----------------------------------------------------------------------
