Armor City
By Neale Genereux
March, 2006

+-----------------------------------------------------------------------------+

Table of Contents

1 License
2 Introduction
3 Installation
4 Game Play
	4.1 Objective
	4.2 Controls
	4.3 Screen
		4.3.1 Mini Map
		4.3.2 Status Bar
	4.4 Units
		4.4.1 Chopper
		4.4.2 Tank
		4.4.3 Missile Truck
		4.4.4 Van
		4.4.5 Infantry
		4.4.6 Engineers
	4.5 On the Map
		4.5.1 Landing Pads
		4.5.2 Bunkers	
		4.5.3 Balloons
		4.5.4 Super Bunkers
		4.5.5 AA Guns
	4.6 Weapons
		4.6.1 Machine Gun
		4.6.2 Bombs
		4.6.3 Rockets
5 Customizing Armor City
	5.1 Customizing Music
	5.2 Customizing Maps
		5.2.1 Bunkers
		5.2.2 Super Bunkers
		5.2.3 AA Guns
	5.3 Customizing Art
	5.4 Customizing Sound
6 Version Information
7 Credits
8 Contact Info
9 Donations

+-----------------------------------------------------------------------------+

1 - License

Armor City is free software; you can redistribute it and/or modify it under 
the terms of the GNU General Public License as published by the Free Software 
Foundation; either version 2 of the License, or (at your option) any later 
version.

Armor City is distributed in the hope that it will be useful, but WITHOUT ANY 
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 
A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with 
this program; if not, write to the Free Software Foundation, Inc., 
51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

Neale Genereux
incarnateRW@hotmail.com

The license file included with this software is named gpl.txt, and is located 
in the root directory.

+-----------------------------------------------------------------------------+

2 - Introduction

Armor City is my homage to the classic game Armor Alley. I have tried to stay 
as true to that game as possible, but sadly Im not the artist, nor the coder 
that the fine people at Three-Sixty Pacific obviously were. In any case, I 
hope that you have as much playing this as I have had making it.

+-----------------------------------------------------------------------------+

3 - Installation

To install the game, place the folder named "armor" anywhere on your GP2X SD 
card. As long as the "images" folder remains intact, this should be all thats 
required for Armor City to run.

+-----------------------------------------------------------------------------+

4 - Game Play

The game play of Armor City is closly based on that of Armor Alley, so 
hopefully if you've played that, this should sound familiar.

4.1 - Objective

The main objective of the game is to get a van into the enemy base. As soon as 
this is done, youve won the map. However, if the enemy gets one of their vans 
into your base, or you run out of helicopters, the game is over. In order to 
purchase vans and other units, you need money, and the more bunkers you control,
the more money you'll get.

4.2 - Controls

Joystick Push	- Select Menu Item
Joystick	- Move Chopper
R		- Change Direction
A		- Drop Bomb
B		- Fire Rocket
X		- Fire Guns
Y		- Drop Infantry
L + A		- Purchase Tank
L + B		- Purchase Van
L + X		- Purchase Truck
L + Y		- Purchase Infantry
L + R		- Purchase Engineers
L + Select	- Purchase Extra Chopper
Start		- Pause
Select		- Change Song


4.3 - Screen

The screen is divided into 3 main areas: The Play Area, the Mini Map, and the
Status Bar.

4.3.1 - Mini Map
The Mini Map is displayed at the top portion of the screen. All active units
can be seen on the minimap, as well as the location of bunkers, balloons, and
rockets.

4.3.2 - Status Bar
The Status Bar is just below the Mini Map. It displays your ammo, lives, and
fuel remaining. The red bar indicates fuel; if this bar runs out, you're dead.
To get more ammo and to refuel, return to the landing pad. When you are
completly restocked, the red bar will turn green.

The Status Bar does NOT display your health. If you're smoking a lot, its 
probably a good idea to head back to your landing pad.

4.4 - Units

There are 5 different types of units in Armor City:

4.4.1 - Chopper
The chopper is equipped with guns, bombs, and missiles. Choppers fly much
slower backwards than forwards, so make sure you're switching direction
when you need to be somewhere in a hurry.

4.4.2 - Tank
The tank is equipped with a gun, and will shoot at anything that gets
in its way. If an unfortunate foot soldier runs into a tank, he'll
likly be squished.

4.4.3 - Missile Truck
The missile truck carries one heat seaking missile, and will fire at
any enemy chopper that gets too close. Once the missile's gone, the truck
won't do you much good offensivly, but it may take out an infantry or two
before it goes down for the count.

4.4.4 - Van
Vans have no weapons, and are only good at taking enemy bases. They'll need
lots of protection if they're gonna make it to the other end of the map.

4.4.5 - Infantry
Infantry have machine guns, but their main use is taking over bunkers. Any
infantry passing an enemy bunker, or a bunker that is uncontrolled, will
try to take it over. You can pick up infantry by landing in front of them.
Infantry get one parachute, and one parachute ONLY, so don't drop them
from high heights unless they haven't been dropped before.

4.4.6 Engineers
Engineers are infantry that can rebuild destroyed AA guns. They do not
capture bunkers. If you pick up an engineer, they become regular infantry.

4.5 - On the Map

Knowing whats on the Armor City map will help you win:

4.5.1 - Landing Pads
These are the home bases for each team. If a friendly chopper lands on one,
it will be healed and restocked. If an enemy chopper gets to close, the
landing pad will defend itself with heat-seaking rockets.

4.5.2 - Bunkers
Bunkers give money to whoever controls them, so its a good idea to capture as
many as you can. Passing infantry will try take over bunkers.

4.5.3 - Balloons
Balloons come from bunkers. Their main purpose is to impede the enemy 
chopper's advance. If a balloon is destroyed, or detached from its bunker, 
passing friendly infantry will rebuild it. Friendly balloons don't do
anything when you run into them, but enemy and floating balloons are leathal.
You can tell which team the balloon belongs to by the direction its facing
(assuming its attached to a bunker).

4.5.4 Super Bunkers
Super Bunkers are reinforced bunkers with gun turrets. They cannot be destroyed
and hold up to 5 infantry. Any approaching unit will be fired upon by the
units occupying the super bunker.

4.5.5 AA Guns
Anti-Aircraft guns will fire on enemy choppers as they pass. They can be 
destroyed by your weapons, passing tanks, or enemy engineers. 


4.6 - Weapons

The Armor City arsenal consists of three types of weapons:

4.6.1 - Machine Gun
The machine gun fires relativly weak ammo straight forward. It has a rapid 
refire rate, but doesn't do a whole lot of damage.

4.6.2 - Bombs
Bombs are only dropped by choppers, and fall straight down (who knew?). They do
a fair amount of damage, and 2 or 3 will kill most units.

4.6.3 - Rockets
Rockets are heat-seaking, and track the enemy chopper. They don't turn very 
well, and eventually run out of fuel, so you can avoid them if you REALLY 
want to.

+-----------------------------------------------------------------------------+

5 - Customizing Armor City

There are several ways you can customize Armor City to make it unique. Please 
note, I take no responsibility for how the game behaves with modified data 
files. In fact, I take no responsibility for how the game behaves with the 
original data files :)

5.1 - Customizing Music

I realize my taste in music is not universal, and, although I greatly 
appreciate all of my friend's music contributions, I also know that not 
everyone will love the music that comes with Armor City. There are two ways you
can fix this problem: 1) turn the music volume down to 0 in the audio options 
menu, or 2) replace my music with your own. In order to accomplish the latter, 
you must modify the songs.opt file in the Armor City install directory. The 
file is formatted as follows:


[# of songs listed]
[song 1 file name]
[song 1 name]
[song 1 artist]
[song 2 file name]
[song 2 name]
[song 2 artist]
...
[song n file name]
[song n name]
[song n artist]
[newline]

Just put your own .ogg files in the audio directory, and replace the entries in
songs.opt with your own. Maybe one day I'll make a tool for this, but not 
today.


5.2 - Customizing Maps

You can also modify the maps that come with Armor City. To do this, you must
modify one of the .map files in the maps directory. These files are formatted
as follows:

[map name]
0
[map width]
[start cash]
[# of map objects]
[map object 1]
[map object 2]
...
[map object n]
[newline]

There are currently 3 supported map objects:

5.2.1 - Bunkers
Bunker entries are formatted as follows:

BUNKER
[X Position]
[max health]
[team (0 = Green, 1 = Blue, 2 = Unassigned)]
[# of starting infantry, should be 0-1]

5.2.2 - Super Bunkers
Super Bunker entries are formatted as follows:

SUPERBUNKER
[X Position]
[team (0 = Green, 1 = Blue, 2 = Unassigned)]
[# of starting infantry, should be 0-4]

5.2.3 - AA Guns
AA Gun entries are formatted as follows:

MAPGUN
[X Position]
[max health]
[team (0 = Green, 1 = Blue, 2 = Unassigned)]


5.3 - Customizing Art

All of the artwork in the images directory can be changed. As long as the 
dimensions are not altered, there should be no problem making it whatever
you want. Altering the dimensions wont necessarily break anything, but I can't
guarantee it will still work. The transparency color is (255, 0, 255).


5.4 - Customizing Sound

Similar to the artwork, all of Armor City's sounds can be swapped out with
whatever you want. Just replace the .wav files in the audio directory.


+-----------------------------------------------------------------------------+

6 - Version Information

v0.30b
-Added Engineers
-Difficulty settings now affect how much damage balloon strings do
-New "Crazy" shrapnel mode makes shrapnel more random

v0.23b
-Content lockdown and bug fixing
-speed optimizations

v0.22b
-Super Bunkers and AA guns
-Real bomb art
-Landing pad intersection fix
-Fixed bug where infantry stopped to shoot when they weren't facing each other
-Fixed 1 crash bug
-Full working audio
-Room-mate-tacular SFX


V0.21b
-Converted all of my cList and cLinkedList objects to their STL equivalents
(vector and list respectivly). Changed some char arrays to STL strings.
-Added loadable maps.
-Fixed 2 CPU Chopper AI crashes.
-All frontend options work.
-Added a 50 unit (per team) cap to keep framerate at a reasonable level.
-Switched to HW accelerated libraries with SDL_mixer support, sound coming soon.

V0.2b 
This is a more complete beta release, with the beginnings of a frontend, and
the ability to actually win the game.

What's Working
-Game mechanics are holding up pretty well, only 1 crash seen so far
-Basic frontend implemented, although it doesn't do much at the moment
-Graves, fireworks, missile trails, and other eyecandy
-Pause feature
-Switched to theoddbots SDL libraries, which fixed my joystick issues

What's Not Working
-The CPU still runs into you a lot
-One crash seen, more probably hidden
-Frontend not fully functional
-Map is still hard coded

What's Coming
-The list below still applies, but top of my current list is:
-Loadable maps
-Code Cleanup
-Finishing the frontend

V0.1b - First Beta Release
This is a very early release, mostly intended to get some basic feedback on 
what I've got so far.

What's Working:
-Basic game framework
-Basic CPU AI
-Unit on Unit fighting
-Missile tracking
-Basic artwork

What's Not Working:
-You can't actually win or lose yet...
-The enemy chopper runs into you a lot
-For some reason the joystick press button isn't registering, along with one
  of the volume buttons. (thats why they're not mapped to anything).
-The whole game is kinda buggy and crashy, but it should improve with future
  releases.
-I'm sure there's some memory leaks that I don't know about.

What's Coming:
-Loadable and editable maps
-Super Bunkers
-Engineers?
-A menu system
-Massive code cleanup
-Winning and losing screens
-More map artwork (trees, graves, etc)
-Background artwork
-Framerate Speedup
-Sound (one day)
-Lots of Tuning
-Difficulty Settings

+-----------------------------------------------------------------------------+

7 - Credits

For the most part, Armor City is the work of me, Neale Genereux. Aside from the 
SDL Libraries, I wrote almost all of the code from scratch (although I used the 
demo program from the "Getting Started" section of 
http://wiki.gp2x.org/wiki/Main_Page to get my project set up). The notable 
exception is the SDL_Collide library which I modified from the one available at 
http://sourceforge.net/projects/sdl-collide/.

The artwork was also my doing, although it was obviously based on the original
Armor Alley artwork. I recreated the infantry and smoke effects very close
to the originals, because I really liked the way they looked.

The sound effects are thanks to myself, and David Hunchak. The music was
supplied by David Hunchak and Brian Greenhill.

Finally, I'd like to thank my University Career, for enduring so much suffering
during my work on this project.

+-----------------------------------------------------------------------------+

8 - Contact Info

Questions, Comments, Requests for me to shut up????
Send them all to incarnateRW@hotmail.com

+-----------------------------------------------------------------------------+

9 - Donations

I appreciate and welcome donations, but don't expect them in any way. If you 
enjoy this game and would like to make a donation, you can do so through PayPal
using my e-mail address: incarnateRW@hotmail.com