===================================

	Monsoon - Q3A
	v1.0

1.  Description
2.  Installation
3.  Offhand Grappling Hook
4.  Alternate Firing Modes
5.  Server Configuration
6.  Credits

===================================
===================================
1.  Description

Monsoon is a modification of id Software's Quake III Arena.  It is primarily a CTF mod, but also supports Deathmatch, Teamplay, and Tourney game types.  Monsoon features an easy to use configuration file that lets the server administrator change many settings to his or her liking, including banning weapons and items, and setting damage amounts.  Monsoon also has alternate firing modes for some weapons and an offhand grappling hook.



===================================
2.  Installation

Unzip the Monsoon zip file into your Quake III Arena directory.  Make sure the path names are left intact.  It will create it's own "Monsoon" folder with all the necessary files inside.  Both clients and the server must install Monsoon for it to work correctly.



===================================
3.  Offhand Grappling Hook

Included with Monsoon is an offhand grappling hook.  All players have it automatically, unless it has been disabled through the monsoon.cfg file by the server administrator.  Players may use the offhand grappling hook by bind a key to the +button5 command.  The syntax follows:

bind <key> +button5

Where <key> is any key on the keyboard.  For example, we'll bind the G key to the offhand grappling hook.  Pull down the console and type this:

/bind g +button5

Then hit enter.  Now pressing and HOLDING the G key will fire the hook.



===================================
4.  Alternate Firing Modes

Some of the weapons in Monsoon have alternate firing modes.  They can be accessed with the "fire_mode" command.  To switch fire modes for a certain weapon, make sure that weapon is in use and hit the key you bound to fire_mode.  A visual indicator on the player's screen will tell him/her what mode they are in.  As of now, only a few weapons have an alternate firing mode:

Grenade launcher: Detpipes
Detpipes look like normal grenades but they do not bounce and won't explode until either they are blown up with the "detpipes" command or 60 seconds has past.  A player's detpipes will explode if the player is killed.

Rocket Launcher: Atomic Rockets
When enabled, the user will fire a single rocket that does damage equal to 75 * the number of rockets the user is carrying.  It will fly very slow.  Firing an atomic rocket empties the user's inventory of rockets.  For example, if a player has 10 rockets and fires an atomic, the total damage will be 750.  The damage per rocket can be adjusted in the monsoon.cfg.

Lightning Gun: Kamikazi Discharge
If the user fires his/her lightning gun while this is enabled, they will explode in an electrical discharge that does damage equal to the number of lightning ammo that they have times half the damage of the lightning gun.  VERY effect for cleaning out the defense in CTF.  You lose a frag in the process.

Plasmagun: Bouncing Plasma
Bouncing plasma does just what you think: it bounces off walls.  The draw back is the shortened range, the will only exist for 2 seconds before exploding.

Although not an alternate firing mode, the server administrator can enable a wall piercing railgun (on by default) that will pass through one wall that is 96 "Quake Units" in thickness or less.  The number of walls that the slug will pass through can be changed in the monsoon.cfg file.

The alternate fire modes can all be disabled with the alt_fire_ variables.  Use a 1 for on and 0 to disable them.



===================================
5.  Server Configuration

The included Monsoon.lnk link will start up Monsoon with the parameters necessary to run a listen server.  All players connecting to a monsoon server must have the fs_game parameter set to "monsoon".  Fs_game can ONLY be set from a command line.  Doing so in game will not work.  Sv_pure must also be set to zero to enable the client side.  Here is a suggested command line for a monsoon listen server:

PATHNAME\QUAKE3.EXE +set fs_game monsoon +set sv_pure 0

For a dedicated server you can use this:

PATHNAME\QUAKE3.EXE +set fs_game monsoon +set sv_pure 0 +set dedicated 2

Note that dedicated is set to 2 so that the server will be deathmatch and log into the id master server.  You can also use 3 and 4, for teamplay and ctf servers respectively.  PATHNAME must be set to point to the directory containing your Quake3.exe.

All the settings for Monsoon are set within the monsoon.cfg configuration file, located in the monsoon base directory.  Simply open and edit the monsoon.cfg with any text editor, like notepad or wordpad. 

Current Variables:

Toggle offhand grappling hook

Set the grappling hook speed

Set starting weapons

Ban weapons, items, ammo, runes

Set weapon damage amounts

Set number of walls that railgun slugs can pierce

Toggle alternate fire modes for gl, rl, lg, and pg

Set respawn times for weapons/ammo/items/health/powerups

At the bottom of the monsoon.cfg file is a commented out section containing standard variables for Q3A.  Use them if you like (uncomment them).


===================================
6.  Credits

Willi "Cherry" Roberson - Lead Programmer
tadao@stargate.net

Derrick "Chaos" Miller - Server Administrator, Game Design
dcs@ndak.net

Will "Telcanty" Stallwood - Webpage Design, Graphics
telcanty@digitalpallet.com

Clan Genocide Kings
http://gk.tzo.com