----------------------------------------------------------
GANG GARRISON 2
----------------------------------------------------------
created by
mrfredman, MedO, and Synnah

a TF2 Demake

Two feuding, quasi-legal freelance security and espionage firms endlessly 
square off against each other in treacherous battlegrounds in an attempt to 
acquire each other's deepest secrets. A demake of a 3D game in 8-bit, 
side-scrolling style.

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

Contents:
I. Meet The Controls
II. Meet The Classes
III. Meet The Gameplay Guide
IV. Meet The Maps
V. Meet The Options Menu
VI. Meet The Credits


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

I. Controls:

W: Jump
A: Run Left
D: Run Right

Mouse Cursor: Aim
Left Mouse Button: Fire Weapon
Right Mouse Button: Use Special Ability
Left Mouse Button + Right Mouse Button: Activate Superburst (as Healer)
F: Taunt
B: Drop Intel

E: Need Healing!
Z: Chat Menu (Emotes)
X: Chat Menu (Interests)
C: Chat Menu (Commands)

N: Open Team Menu
M: Open Class Menu
(hold) Left Shift: Show Scoreboard
F12: Mute Sound


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

II. The Classes:

Meet The Runner:
	Quick as the wind, the Runner
	excels in recovering objectives.
	He can double jump in mid-air.
   Hit Points: 100
   Weapon: Scattergun
   Special abilities: Jump again while in the air!

Meet The Firebug:
	Gets close to burn his foes.
	Pushes enemies and projectiles
	away with a burst of air.
   Hit Points: 120
   Weapon: Flamethrower
   Special abilities: Right-click to launch enemies and reflect rockets and mines!

Meet The Rocket Man:
	Strong yet graceful, he can
	launch himself skyward with his
	rockets as well as do damage.
   Hit Points: 175
   Weapon: Rocket Launcher
   Special abilities: Fire at your feet when you jump to reach great heights!

Meet The Overweight:
	A mammoth of a man, carrying
	a heavy weapon that will shred
	enemies. He can sure eat, too!
   Hit Points: 200
   Weapon: Chaingun
   Special abilities: Right-Click to eat your tasty Manvich to fill your belly and your HP!

Meet The Detonator:
	A master of explosives, the
	Detonator can stick mines to 
	any surface and set them off.
   Hit Points: 120
   Weapon: Minegun
   Special abilities: Right-click to detonate up to eight mines at once!

Meet The Healer:
	His all-purpose healing gun can
	both heal his team from afar
	and rain syringes on foes.
   Hit Points: 120
   Weapon: Needlegun (right-click)
   Special abilities: Heal your teammates with primary fire! Regenerate health over time!
		      Charge your Superburst then Right-Click while holding Left-Click to make a team-mate invulnerable!

Meet The Constructor:
	A brilliant inventor, the 
	Constructor can build sentry
	guns that protect whole areas.
   Hit Points: 120
   Weapon: Shotgun
   Special abilities: Right-click to open the Build menu, and build or un-build a sentry turret!

Meet The Infiltrator:
	Can become invisible to slip
	behind enemy lines and deliver
	a fatal strike with his knife.
   Hit Points: 100
   Weapon: Revolver
   Special abilities: Right-click to become invisible to foes! Left-click while invisible to stab!

Meet The Rifleman:
	Armed with his trusty rifle
	and dead aim, his zoom scope
	allows him to attack from afar.
   Hit Points: 120
   Weapon: Sniper Rifle
   Special abilities: Mouse around the screen to zoom further than any other class!

Meet The Secret Character:
	There is totally no secret
	character to speak of. None.
	And you can quote me on that.


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

III. Gameplay Guide

Connect to a server by either manually connecting to an IP address and port of 
a game you know, or open the lobby and join a server by clicking its name. The 
lobby will show the current map, number of players, and IP of servers running.

There are two gameplay modes: Capture the Flag and Control Point

Choose a team, RED or BLU, or select AutoSelect and let us choose the fairest place. 
Press N to change your team, or to Spectate and watch the action! Keep in mind you 
tie up a player slot on the server as a spectator!

Press M to open the Class Menu and choose your class. Choose option 0 to let 
us pick a class that might suit you!

The heads-up display at the bottom of your screen shows your class, your team, and a 
representation of your current health. The scoreboard shows the current score, and the
condition and location of each team's intelligence.

Capture the Flag:
Find the opposing team's intel and return it to where yours usually sits to score a point.
Score a certain number of points to win the round!

Control Point:
Capture or defend Control Points to win the match. Control all of the points to win!
----------------------------------------------------------

IV. The Maps

A. The Official Maps:

To run a server using only these maps, open gg2.ini and make sure no custom
map list is specified ("MapRotation=" under [Server] should be left blank). To change
the order the maps are played, change the numbers next to the map names; the maps
will play in numerical order from least to greatest. Place a zero next to a map to ignore it.

1. ctf_truefort
by fishmatt
This classic layout emphasizes good flagrunning and being able to evade a 
strong defense! The colorful rural scenery hides two industrial strongholds.

2. ctf_2dfort
by Vaati
A simple layout designed for fast games and tactical decisions. Don't neglect the 
lower route!

3. ctf_conflict
by agh
This battleground is filled with varied terrain and odd angles! Watch out, there are 
many places to hide and swipe the intelligence when no one will notice.

4. ctf_classicwell
by fishmatt
A nostalgic scenario with an industrial flavor, there are multiple routes around these
imposing complexes but only a few ways in and out. Keep an eye on the upper route!

5. ctf_waterway
by Taters
This trainyard sits atop a canal. The adjacent buildings house two warring factions. 
Keep your cool and watch for snipers, it's a long clear shot back to your base.

6. ctf_orange
by king metroid
Looming under the shadow of a large central tower, two groups plot each other's
demise. Climb the tower to drop down on unsuspecting opponents!

7. cp_dirtbowl
by Vaati
Somewhere in the middle of nowhere, BLU is ready to launch it's secret wewapon at
RED's base within Mt. Dirtbowl. RED must push forward while BLU must hold them off
on three map fronts in this control point attack style map.

8. cp_egypt
by Tarzan
Under the blazing desert sun, RED and BLU battle to control an antiquated city.
Fight to maintain a hold on all five control points in this majestic CP map.


B. Using Custom Maps:

To run a server using custom maps, make a folder called "Maps" in the same 
path as Gang Garrison 2.1.exe and place the compiled map file (it will have 
a ".png" extension) inside. Create a text file with any name, like "maplist.txt", and 
open gg2.ini. Next to "MapRotation=" under [Server], type the name of this file.

Open your maplist file and type the name of each map you want to play in order:
For instance:

ctf_2dfort
ctf_mynewmap
ctf_orange

would play ctf_2dfort, a custom map with the filename "ctf_mynewmap.png", and 
then ctf_orange. Then it would play ctf_2dfort again. These names are case sensitive.

Players on your server can download maps from the internet when they join if you 
provide a locator file. First, upload your map to the internet, whether on your own 
website or a filehost that allows direct linking. Do not worry if it changes the filename,
as long as it keeps the extension .png it will be fine. Create a file in your Maps folder
called "mapname.locator" where "mapname" is the same as in the file "mapname.png".

Inside this file, simply paste the direct link to your file on the internet. Be careful that
the link is direct and not a php redirect! Now when players join your server, they will
download the map and your locator file so they may also host the map on their servers.


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

V. The Options Menu:

These options can also be set in gg2.ini before running the game.

Player Name: Set your visible name in-game.
Hosting Port: Set the TCP port clients will connect to if you host a game.
Player Limit: Set the number of players, including the host, allowed in your game.
Announce to Lobby: Show your game to players in the Lobby. Setting this to off 
	allows you to host a private game for those who know your IP.
Fullscreen: Set to On to run in fullscreen. Otherwise the game is windowed.
Ingame Music: Toggles the ingame music track on and off.
Particles: Toggles smoke and explosion effects, which can cause lag.
Gibs: Toggles body parts when a character explodes, which can cause lag.


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

VI. Credits and Information

Information about creating content for the game, creating maps using our editor 
Garrison Builder, downloading and running custom maps, and much more can 
be found on the forum at 

ganggarrison.com/forums
   
Gang Garrison 2 

Created By

mrfredman, MedO, Synnah

The FAUCET Team
 
Cube7 aka Chris P. Bacon, Fishmatt, Andrew "cspotcode" Bradley
Vaati, Taimat, Findude, Juicebox360, Jebus_Chris, Scoot


map art by: 
fishmatt, vaati, king metroid, Taters, agh, and Tarzan

With additional art and inspiration provided by the incredible Gang Garrison community!

License:
You may use this game under the GNU GPL, version 3, which is included and visible 
in the game by pressing F1. Static or dynamic linking with other software (the Game 
Maker runtime and the 39dll extension) without applying the GPL to it is allowed though.

This is a demake of Team Fortress 2 by Valve Software. All likenesses and similarities 
are intended as a respectful homage.

This game uses the 39dll networking extension for Game Maker. 39dll was created by 39ster 
and wrapped into an extension by the_doominator.
You can find more information on 39dll at http://gmc.yoyogames.com/index.php?showtopic=90437.
For information on the 39dll extension, visit http://gmc.yoyogames.com/index.php?showtopic=300449.

This game uses the Download Manager DLL, created by Hobbel.  It was wrapped into an extension by cspotcode.
You can find more information on the Download Manager DLL at http://www.hobbl.com/gmdlls/downloadmanager

Readme Changelog
2/7/09 - fishmatt - cleaned everything up for 2.0
5/3/09 - mrfredman - updated things for 2.1