-----------------------------------------------------------------------
Competition Weapons  Alpha Release v0.02
4-3-2000
-----------------------------------------------------------------------


Authors:  (ASK)ZOT---->*
               (ASK)Dimmona
               Mike(OBD)
               Ace [MAP] (webmaster)


Official Comp website:
http://clan.map.com/comp

-----------------------------------------------------------------------
 ZIP file Contents
-----------------------------------------------------------------------

competition_weapons.qst - Gamespy tab for finding
servers running Comp (place this in your gamespy 
tab directory if you use gamespy).

pak0.pak -- Comp pak file

pak1.pak - CTF pak file required for teamplay.

gamex86.dll - Server executable for Windows 
(not required unless running a Comp server)

gamei386.so - Server executable for Linux (not 
required unless running a Comp server under Linux)

autoexec.cfg - Client config file which gets all
the weapon and hook binds working.

motd.txt - Used when running a server.  When
clients connect they will see whatever is in
this file.

maplist.txt - Used when running a server.  This
file specifies the map rotation being used.

compffa.cfg - Used when running a server.  This
config file will setup a server for Comp FFA.

compteam.cfg - Used when running a server.  This
config file will setup a server for Comp teamplay.

compext.cfg - Used when running a server.  This
config file will setup a server for Comp Extinction.

comprext.cfg - Used when running a server.  This
config file will setup a server for Comp Rail-Only 
Insta-Gib Extinction.

compinst.cfg - Used when running a server.  This
config file will setup a server for Comp Rail-Only
Instagib FFA.

comptinst.cfg - Used when running a server.  This
config file will setup a server for Comp Rail-Only
Instagib Teamplay.

-----------------------------------------------------------------------
Weapons
-----------------------------------------------------------------------

1   Blaster
1a SuperBlaster
2   Shotgun
2a Bouncy Sniper  (New variation bounces off of walls)
3   Super Shotgun
3a Freeze Gun
4   Machine Gun
4a Rocket Machine Gun
4b Burstfire Machine Gun
5   Chaingun
5a Streetsweeper
6   High Explosive (HE) Grenades  (this is new and replaces the laggy flames)
7   HE Grenade Launcher
7a HE Bazooka
8a HE Rocket Launcher (this is new and replaces the laggy flames)
8b Laser Guided Rockets
9   Hyperblaster
9b Plasma Rifle
10 Ultra Railgun (new variation of the railgun)

(a indicates alternate weapon which is selected by pressing 
the key stroke twice).

-----------------------------------------------------------------------
Commands
-----------------------------------------------------------------------

0-9  Pressing the numeric keys will select a weapon, pressing it multiple
times will select the alternate weapons.
N - Night Vision   (cmd night vision)
S - Laser Sight (cmd lsight)
f11 - Cycles Zoom Views (cmd zoom 1)
f10 - Original View (cmd zoom 0)
G -  Fires the grappling Hook (holding down the key will cause the hook
to shrink).  Pressing G a second time causes the hook to unhook.
R - Slide up the grapple.
F - Slide down the grapple.
D - Fires a decoy (cmd decoy)
M - Toggle Burst fire for standard machine gun (cmd firemode)

============================================
 * READ THE FOLLOWING ONLY IF INSTALLING A SERVER *
============================================

-----------------------------------------------------------------------
Server Installation
-----------------------------------------------------------------------

Make a weapons directory in your Quake2 Directory, 

eg. c:\quake2\weapons

Unzip the server .zip file into this directory (use winzip or similar
zip program for Windows or gnu zip for Linux).

*Note* the gamex86.dll / gamei386.so executable
replaces the old WOD 6.08 executable so that if you 
want to run both the old WOD and Comp Weapons you must
create two Quake2 directories.  We apologize for this step but
it's the only way to minimize the changes needed on the 
client side.

-----------------------------------------------------------------------
Configuring a Competition Weapons server
-----------------------------------------------------------------------

motd.txt - This is the server "message of the day".  It'll is shown briefly
to players when they log in.   It is important to keep this file fairly
small otherwise players will overflow when they first connect and be
unable to stay connected to the server.  

Maplist.txt - This file specifies all the maps that you wish to run.  Map selection
is based on the min and max # of players based on the maplist and the number 
of players currently connected to the server.  

The following is an example maplist (make sure that the comments in 
parenthesis at the end of each line are removed as this will cause an error).

q2dm1    0   15    (play this map with any number of players up to 15)
q2dm2    0   0     (don't play this map)
q2dm3    5   20    (play this map with a minimum of 5 but no more than 20)
q2dm4    15  5     (this map will never be played!)

compxxxx.cfg - (e.g. compffa.cfg) These files provide a starting point for 
setting up a server.  The setting should be familar to anyone who has run a 
WOD server in the past w/ the exception of two new parameters:

"set gametype X" (where X is 0,1,2,3,4,5) which correspond to:
0 = Competition Weapons DM Free for All (FFA)
1 = Competition Weapons DM Teamplay
2 = Competition Weapons Extinction
3 = Competition Weapons Rail Only Extinction 
4 = Competition Weapons Rail-Only Insta-Gib FFA
5 = Competition Weapons Rail-Only Insta-Gib Teamplay

The gametype parameter replaces the confusing combination of ctf, teamplay and
deathmatch parameters that were used before.

Another new parameter is "set ammo_given X".  Where X is 1,2 or 3
This option allows the server admin to set the ammount of ammo given for
for each ammo clip or weapon picked up.  1 corresponds to "Stingy", 2 to
"Normal" and 3 to "Generous".

For the standard setting of 2, the current values for ammo given per cliip or weapon picked up are:

grenades 6
rockets    6
shells     10
slugs      10
bullets    50
cells       50

Setting ammo_given to 1 halves this amount while setting ammo_given to 3 doubles the amount. 

-----------------------------------------------------------------------
Setting dmflags
-----------------------------------------------------------------------

Comp settings currently do not allow unlimmited ammo (UA) dmflag settings.
This was a difficult decision to make based on the popularity of UA servers but
weapon balance through ammo consumption is not possible if unlimmited ammo
is set.

Comp also does not enable quad damage as the weapons are already heavy
enough.

Note:  Extinction configurations always use spawn farthest.

For FFA  (free for all) server configurations the following describes
all of the dmflags which may be set.  

// dmflags settings:
//
//        DF_NO_HEALTH            1
//        DF_NO_ITEMS             2
//        DF_WEAPONS_STAY         4
//        DF_NO_FALLING           8
//        DF_INSTANT_ITEMS        16
//        DF_SAME_LEVEL           32
//        DF_SKINTEAMS            64
//        DF_MODELTEAMS           128
//        DF_NO_FRIENDLY_FIRE     256
//        DF_SPAWN_FARTHEST       512
//        DF_FORCE_RESPAWN        1024
//        DF_NO_ARMOR             2048
//        DF_ALLOW_EXIT           4096
//        DF_QUAD_DROP            16384
//        DF_FIXED_FOV            32768
//
// The default dmflags for FFA  (532) equate to:
//
//   DF_WEAPONS_STAY + DF_INSTANT_ITEMS + DF_SPAWN_FARTHEST
//
// which works out to:
//
//   4 + 16 + 512 = 532

For Teamplay server configurations the following describes all fo the
dmflags which may be set:

// Sample Server Configuration File for WoD:Extinction
//
// dmflags settings:
//
//        DF_NO_HEALTH            1
//        DF_NO_ITEMS             2
//        DF_WEAPONS_STAY         4
//        DF_NO_FALLING           8
//        DF_INSTANT_ITEMS        16
//        DF_SAME_LEVEL           32
//        DF_SKINTEAMS            64
//        DF_MODELTEAMS           128
//        DF_NO_FRIENDLY_FIRE     256
//        DF_SPAWN_FARTHEST       512
//        DF_FORCE_RESPAWN        1024
//        DF_NO_ARMOR             2048
//        DF_ALLOW_EXIT           4096
//        DF_QUAD_DROP            16384
//        DF_FIXED_FOV            32768
//        DF_CTF_FORCEJOIN        131072  
//        DF_ARMOR_PROTECT        262144
//        DF_TEAMREBALANCE        524288
//
// The default dmflags here (263444) is set up as:
//
//   DF_WEAPONS_STAY + DF_INSTANT_ITEMS + DF_NO_FRIENDLY_FIRE
//	+ DF_FORCE_RESPAWN + DF_ARMOR_PROTECT
//
// which works out to:
//
//   4 + 16 + 256 + 1024 + 262144 = 263444

NOTE:  DF_TEAMREBALANCE - Replaces DF_CTF_NO_TECH (since there 
aren't any techs in WoD).  If set, then after each game, the teams are 
rearranged according to players' frags-per-minute.  (This is probably 
what you'd want to run on a public Teamplay server.)

-----------------------------------------------------------------------
Setting weaponban and fragban.  
-----------------------------------------------------------------------

Fragbanning in Comp has been removed because it is no longer needed (all the
weapons are better balanced).

Values for weaponban:

Ban super blaster			1
Ban shotgun			2
Ban sniper gun			4
Ban super shotgun			8
Ban freeze gun			16
Ban standard machinegun		32
Ban machine rocket gun		64
Ban burstfire machinegun		128
Ban chaingun			256
Ban streetsweeper			512
Ban grenades			1024
Ban grenade launcher		131072
Ban bazooka			262144
Ban rocket launcher		524288
Ban guided rocket launcher		1048576
Ban hyperblaster			2097152
Ban plasma rifle			4194304
Ban railgun			8388608

-----------------------------------------------------------------------
Featurebans.  
-----------------------------------------------------------------------

For now, the jetpack, scanner, push-pull, triplasers, kamikaze
and inulnerability have all been removed.  Additional banning
can be done by  providing a "set featureban xxx" in your server
configuration file where xxx is the sum of the features listed below:

Ban bandolier		1
Ban ammo pack		2
Ban silencer		4
Ban rebreather		8
Ban environment suit	16
Ban adrenaline		32
Ban megahealth		64
Ban power armor		128
Ban decoy		512
Ban grappling hook	               1024
Ban player ID		2048
Ban lasersight		8192
Ban nightvision		32768
Ban zoom view		262144

*Note*  For Insta-Gib rail-only configurations all weapons and items
other than the rail and grapple are automatically banned to provide
the ultimate in zero lag gaming.

-----------------------------------------------------------------------
Starting the server.  
-----------------------------------------------------------------------

To run a dedicated server, the command is:

quake2 +set dedicated 1 +set game weapons +set port 'xyz' +exec 'configfile.cfg'

where xyz is the TCP/IP port being used and configfile.cfg is the desired server configuration.  Leaving off the "set port  xxxx" will result in port 27910 being used (the default port).  Replace 'configfile.cfg' with:

compffa.cfg - for standard free for all (FFA).
compteam.cfg - standard teamplay.
compext.cfg - standard extinction teamplay.
comprext.cfg - Rail only extinction teamplay.
compinst.cfg - Rail only Insta-Gib FFA.
comptinst.cfg - Rail only Insta-Gib Teamplay.

-----------------------------------------------------------------------
Other server commands/options.  
-----------------------------------------------------------------------

IP banning:  You can add or remove addresses from the filter list with 
"sv addip <ip>" and "sv removeip <ip>".  The ip address is specified 
in dot format, and any unspecified digits will match anyvalue, so you 
can specify an entire class C network with "sv addip 192.246.40".

removeip will only remove an address specified exactly the same way.
You cannot addip a subnet, then removeip a single host.

There is one more way to ban a player.  "sv kickban <player#>" will ban
the player's IP address and then kick them from the server.

"sv listip" prints the current list of filters.  "sv writeip" dumps
"sv addip <ip>" commands to listip.cfg so it can be execed at a later date.
The filter lists are not saved and restored by default.

In addition, there's a "filterban" variable.  If set to 1 (the default),
then ip addresses matching the current list will be prohibited from
entering the game.  If set to 0, then only addresses matching the list
will be allowed.  This lets you easily set up a private game, or a game
that only allows players from your local network.

idledetect - The number of minutes a player can be idle before they're
kicked.  (Set it to 0 to turn it off.)

