Description
===========

This eggdrop tcl script adds some public commands like !score, !help and !mines
to a standard eggdrop. These commands provide various interesting info about
ships and odg in the Empirequest game. Besides that it also does cost
calculation of mines/probes, the most important means of income in Empirequest.
It utilises the tcl Mpexpr library in order to facilitate integers larger than
32 bit. This may make use of the script on windrops hard or impossible (more 
on that in INSTALL). 
All info concerning ships and odg is stored in 2 .info files of which the
format is explained later in this document. This was done to make it easier to
update the script for new rounds of Empirequest. The tcl script does contain
several variables that have to be editted at install time (see INSTALL).


.info Files
===========
All info about ships is stored in ships.info. This file contains a fixed set of
information lines for each ship.
Example:

[A]                                           --> abbreviation
name=Annexer                                  --> name of the ship
class=Cruiser                                 --> class of the ship
tclass=                                       --> class it targets
armour=180                                    --> amount of armour
fireorder=8                                   --> firing order
t=12000                                       --> tellerium cost
k=10000                                       --> krypton cost
travelttime=8                                 --> travel time
guns=2                                        --> number of guns
damage=0                                      --> damage per gun
accuracy=35                                   --> accuracy in %
agility=40                                    --> agility in %
facility=Tractor Beam Tower                   --> required facility
cloak=No                                      --> info about cloaking
special=                                      --> special info
desc=Captures Mines and Probes from the enemy --> ship description

The file has to contain each of these lines for each ship else the script won't
load. As the example above already shows lines without info, like special=,
have to be included. The order has to be exactly the same as in the example
above.
A sample ships.info has been included (based on round 5 manual)

Like all ship info is stored in ships.info all odg info is stored in odg.info.
The format of this file is similar to that of ships.info. The only difference
is that several info lines have been removed, like traveltime=.
Example:

[ORP]                                    --> abbreviation
name=Orbital Rocket Platform             --> name
class=Battleship                         --> class
tclass=Cruiser                           --> class it targets
armour=800                               --> amount of armour
fireorder=1                              --> firing ordre
t=20000                                  --> tellerium cost
k=15000                                  --> krypton cost
guns=5                                   --> number of guns
damage=100                               --> damage per gun
accuracy=25                              --> accuracy in %
facility=Nuclear Center                  --> required facility
special=                                 --> special info
desc=Deals damage to the selected target --> description

Just as with ships.info the order of the lines is important and they all have
to be present including the empty ones.
A sample odg.info has been included (based on the round 5 manual).

Contact Information
===================
Email: shug@xim.f2s.com
IRC: XiM on irc.icerealm.net (you can usually find me in #icerealm)
Website: http://www.xim.f2s.com
