README file for Atomic Tanks (version 2.3)
============================================

What is Atomic Tanks?
========================

Atomic Tanks is a game in which you control an overly-powerful
tank and attempt to blow up other highly powerful tanks. Players
get to select a number of weapons and defensive items and then
attack each other in a turn-based manner. The last tank standing
is the winner.



How to I get/install Atomic Tanks?
===================================

To gain a copy of Atomic Tanks, go to our
website at http://atanks.sourceforge.net
Click on the "Download" link and select the
latest version of Atanks.

Note: If you have a pre-compiled (binary) copy
of Atomic Tanks, you will need the Allegro graphic
package. See http://allegro.cc/
Also, if you are going to compile/build Atomic Tanks
from source code, you will need the Allegro development
package. These packages can be found at
http://allegro.cc/files/
Please also note, those of you running Linux can
usually get Allegro packages through your distribution's
package manager. These packages are named (at least on Fedora)
"allegro" and "allegro-devel" respectively. Debian
uses, I think, "allegro" and "allegro-dev".


If you are using a pre-built, binary copy of Atomic Tanks,
please see the next section on running the game. Next
we will cover compiling from source.


To compile Atomic Tanks, please make sure you have
the Allegro libraries installed (see above). Next,
open a command console (shell) and move into the
directory containing the Atomic Tanks package.
This file will probably be named "atanks-2.0.tar.gz".
Then run the following commands:

tar zxf atanks-2.0.tar.gz
cd atanks/src
make

If all goes well, this will create a file in the atanks
directory called, "atanks". So, type the following:

cd ..


Now we can get to running the game. If you encounter
an error while running "make", then please see the
last section of this document, which covers reporting
bugs.





How do I run Atomic Tanks?
====================================

You can run the atanks file by typing "./atanks"
from a command line, or double-clicking the file
in a file browser. Atomic Tanks tries to use
reasonable defaults, so there is rarely a need to
use the command-line options. However, Atomic Tanks
supports the following options:

./atanks -h   (Print list of credits, command-line options and exit.)
./atanks -fs  (Run the game using the entire screen. Full screen mode.)
./atanks --windowed  (Run the game in a window. This is the default).
./atanks --nosound  (Run the game without sound. Sound is on by default.)
./atanks --noname   (Do not display player names over the tanks.)
./atanks --width <number>  (Run the game in a window with a set width in pixels.)
./atanks --tall <number>  (Run the game in a window with a set height in pixels.)
./atanks --datadir <data directory>  (Path to the directory with Atank's data files.)
./atanks --depth <number>  (Sets pixel depth. Use either 16 or 32 here.)

Most of these options can be used together, with the exception of "-fs"
for full screen mode. Simply running "./atanks" is the same as running
Atomic Tanks with the following options:
./atanks --windowed --width 800 --tall 600 --datadir . depth 32




How do I go about creating a player for myself?
================================================

when you first run Atomic Tanks, the first thing you'll need to
do is create a player/tank for youself. Click on the "Players"
button and click "Create New". Enter the name you want and
pick the colour you'd like your tank to be. That's all you'll
need to do. Click the "Okay" button. Then click the
"Back" button and, most importantly, click "Play"!

Once you click play, you'll have a chance to select which
tanks you'll be playing against. You can get anywhere from 2
to 10 tanks on the playing field at one time. Don't forget
to select yourself!

The next screen gives you a chance to buy weapons and defensive
items. There is no perfect combination, so experiment a little.
You can buy an item (assuming you have enough funds) by
left-clicking on the item. To sell the item, right-click on
the item. When you've completed your selection, click "Done".

The final screen you'll see is where the action takes place!
Use the left and right arrow buttons on your keyboard to
aim your tank's gun. The up and down arrow keys adjust the
speed (power) of the shot. The space bar fires the tanks gun. If
you want to change which weapon you will be using, press the
TAB button or the BACKSPACE button. The round is over when 
there is one tank left standing.



Where do I report bugs or send requests?
=========================================

Atomic Tanks is a great game, but it isn't perfect.
We, the developers, are always trying to improve the
experience our game brings to you. If you have
a problem with installing or playing Atomic Tanks,
please let us know. Go to http://atanks.sourceforge.net
and click the "Forum" link. We encourage you to
give your feedback. Please give as many details as
possible so we can help you.

