
		ACTION QUAKE:GANGSTERS! setup guide

###############################################################################
Table of Contents
###############################################################################
1.  Introduction
2.  Installing
3.  Configuring
 3.1 Configuring "gangsters.ini"
 3.2 Configuring "maplist.ini"
 3.3 Configuring "rules.txt"
 3.4 Configuring "motd.txt"
4. Starting an AQ:G! server.
App A: Files
App B: Links
App X: Version control

###############################################################################
1. Introduction
###############################################################################
Welcome to ActionQuake:Gangsters! aka AQ:G!

This txt file is meant to be an aid in installing an AQ:G! server, altough
it presumes that YOU are familiar with running Q2 servers already. If not
check out 'Appendix A' for links to FAQ's and sites that might be of help.
Action Quake:Gangsters! is an addon to Action Quake, this addon will let you
still be able to play ordinary Teamplay and Deathmatch as well as Gangsters! 
And it even adds a few new options to regular TP and DM.

###############################################################################
2. Installing
###############################################################################
There are a few files that you need to have on the server, but they are
mostly configuration files. And 95% of those files will go into the
gangsters directory.

Okay lets copy those files to where they belong (they should extract in to the
correct directories themselfs.).

Following files should be copied to "quake2/action/"
aq2.ini 
maplist.ini
gamei386.so

Following files should be copied to "quake2/action/gangsters/"
gangsters.ini
maplist.ini
motd.txt
rules.txt
aqg_<mapname>.ini 

All files except the "aqg_<mapname>.ini" can and should be modified, if you want
to modify the "aqg_<mapname>.ini" please read an appropriate tutorial on the subject.
Ohh yes dont thouch the "gamei386.so" thats a binary file :)

###############################################################################
3. Configuration
###############################################################################
The two ini files that are copied to the "quake2/action/" directory are
optional and not needed if your not planning to run regular TP/DM and want
to use some of the new custom options available like mapvoting, limited
chasecam and auto zoom-out on running snipers. 

"aq2.ini" is a light version of "gangster.ini" and the two "maplist.ini"
files are identical.
-------------------------------------------------------------------------------
3.1 Configuring "gangsters.ini"
-------------------------------------------------------------------------------
Map voting options

use_mapvote:0/1 	
	- Turns map voting off/on. 0=off and 1=on

mapvote_min:1
	- Minimum number of clients before map voting is allowed.				 

mapvote_need:0
	- Percent of clients required to vote (0-100)

mapvote_pass:50
	- Percent of yes votes required to pass the vote (1-100)

# Misc custom options
random_maps:0
	- Set to "1" to enable random map rotation of the maps listed in  "maplist.ini"

limchasecam:1
	- Limit the chasecam in teamplay valid values are 0-2, where 0 is off.
	
penjump:0
	- Penalize jumpers.  Set to "1" to enable it, this will modify the spread while your jumping.

penzrun:0
	- Penalize snipers when running.  Set to "1" to enable it
	
bodylimit:8
	- Limit the number of dead bodies lying around. This will reduce lag for modem player 

# specific AQG variables
locationlimit:40
	- This is the maximum number of locations that can be read
        from a map ini-file (including spawn and flag points)


# these overrides the settings in action.ini, makes it possible to have TP & AQ:G! 
# running on the same server with the diffirent skins/names for the teams on each server 

team1_skin:male/aqgthug
	- The model/skin that team1 will use.

team2_skin:male/aqgvillain
	- The model/skin that team2 will use.

team1_name:Thugs
	- The name of team1

team2_name:Villains
	- The name of team2

leader1_skin:actionmale/aqgthugboss
	- The model/skin the boss of team 1 will have

leader2_skin:aqg_velvetj/aqgvillainboss
	- The model/skin the boss of team 1 will have

leader_both_min:0
	- This should be less than (or equal to) the "maxclients"   
        variable. If set to '0' then only 1 boss will be used all the time, if
	any other 'value' <= 'maxclients' will result in 2 bosses being used when the 
	number of clients equals the 'value' you have set.

leader_hero:0
	- Set to "1" to enable hero-mode for the leader(s).  If set,
        the leader will become an action hero and have better aim than
        the other players.

aqg_sounds:1
	- Set to "1" to enable AQG sounds (including radio messages)
	
-------------------------------------------------------------------------------
3.2 Configuring "maplist.ini
-------------------------------------------------------------------------------
In this file you will just list each map that you would like to have in rotation
and be able to vote on. Each map name on seperat lines.

Example "maplist.ini":

# Use # at the begining of lines to make comments in the file
#
BLOCKWAR
avenue1
city
teacher

-------------------------------------------------------------------------------
3.3 Configuring "rules.txt"
-------------------------------------------------------------------------------
This text is displayed "as is" when a client issues the rules command.
So feel free to write what ever you like. There are some limits though, all
Quake2 font limitations are still valid. And the amount of lines that can
be displayed and also the lenght of the lines to be displayed is limited to the
same as Q2/AQ2.

-------------------------------------------------------------------------------
3.4 Configuring "motd.txt"
-------------------------------------------------------------------------------

This is the motd that will be displayed when you enter a AQ:G! server.
The same limits as for the ordinary AQ2 motd is in use.

###############################################################################
4. Starting a AQ:G! server.
###############################################################################

Now that we have configured AQ:G! to our liking we can start it the 
sameway as any other AQ TP server. Except that you should "+set Teamplay 2"
instead of "+set Teamplay 1"

Basic Example:

quake2 +set game action +set teamplay 2 +set game noscore 1

(If you dont understand this please check the links section for places you 
can find information on running a server.

###############################################################################
Appendix B: LINKS
###############################################################################

AQ:G!		http://www.planetquake.com/gangsters
AQ 		http://action.telefragged.com
Q2 server FAQ	http://www.planetquake.com/q2-serv
LinuxQuake	http://www.linuxquake.com
Wedges AQ site  http://action.wedge.net

###############################################################################
Appendix X: Version control
###############################################################################

Updated: 

07.04.99 19:46 CET by JPT
31.03.99 16:30 CET by JPT

