
========================================================================================
Title                   : Base Defence 2
Filename                : Q2BD_080.zip
Version                 : 0.80 
Release date            : 9/23/98
Author                  : Tom "Lab-Rat" McKeown
Email                   : lab-rat@bigfoot.com
Quake Clan              : Know Fear Crew
Web Site		: www.jmckeown.demon.co.uk

Introduction
------------

"A few men defending their home are greater than an army fighting without cause."

Teamplay and co-operation are key to this deathmatch mod.  Teams take it in turns to 
defend a fortified base.  Access to the enemy base requires the successful destruction of
a perimeter wall or doorway.  A button deep within the base triggers the fall of the 
base to an attacking player.  Bonuses are structured to reward teamplay and make it 
advantageous to take the base quickly and to hold it for as long as possible.
(Note Base Defence is NOT Team Fortress.)

This patch has been designed using Zoid's Q2CTF code.  This was intentional so that
setting up a Base Defence server will be as similar as possible to setting up a 
CTF server.  Also, so that players of CTF will quickly be able to settle into playing Q2BD.

Credits
-------

The Q2BD team:- 

Tom 'Lab Rat' McKeown - lab-rat@bigfoot.com
     Programming, Art work and levels.
Tim 'TricksteR' Moxon - trickster@elstead.demon.co.uk
     Original Base Defence idea, levels (to come soon).
Keif 'Data' Gwinn - keif@keif.cix.co.uk
     Art work.

Play testers:-

Steve 'Haze' Masters, 
Naff 'Gizmo' Brice, 
Mark 'Deadmeat' Cousens, 
Ben 'Breakfast' Moxon

Thanks to:- 

Dave 'Zoid' Kirsch - zoid@idsoftware.com
     For Capture the Flag, the code on which this mod based.
Cable Hicks - hicks@goldrush.com
     Author of AdQuedit <http://goldrush.com/~hicks/adquedit/> an excellent editor 
     which replaced several other utilities.
Alexander Malmberg - alexander@malmberg.org
     Author of the Quest level editor <http://www.frag.com/quest/>.
Shawn 'LagMeFragMe' Lander - scl@ufl.edu
     Deathmatch only source.
Andrew 'Blackmane' Griffin - andrew_griffin@bigfoot.com
     Code for the .ini file. <http://www.planetquake.com/qdevels/>
David 'crt' Wright - wrightd@stanford.edu
     Fast weapon switch code.

Installation
------------

To install either a client or a server unzip the archive directly into your Quake 2 
directory, remembering to use the 'use directories' function.
To run a client load up Quake 2 normally, and connect to a server running the Q2BD
patch.  Quake 2 will automatically switch the game directory for you.
To start a Q2BD server load up Quake 2 with '+set game q2bd' in the command line. 
Start a deathmatch server with the options you want and switch to a Q2BD level.  Base
Defence game play and team options will run automatically.


The Story
---------

(Unfortunately the storyline for Q2BD was not ready in time for this releace.
We will make every effort to ensure that it will be included in the next version.)


The Rules
---------

Each base defence level contains some sort of base; a castle, stockade, fort, etc.  
The players are split into teams, one of which is in defence of this base.  The 
attacking players may be able to access the base in several ways, the main one being 
some sort of weakness in the structure of this base.  Once this weakness has been 
destroyed a button within the base will cause the teams to be swapped and bonuses 
to be scored.  The defending team is - of course - trying to prevent this 
from happening.

Upon logging onto a Base Defence server you will either be assigned to one of the 
teams, or you will become an invisible observer while you decide which team to join.
Once you begin play you will teleport to a relevant location; inside the base for 
defenders, outside for attackers.  This prevents attackers from gaining early access 
to the base button.  

The base’s defences are vulnerable to both teams attacks, so stray fire by the 
defending team is to be avoided.  

Kills by a defender while he or she is outside of her base will not score any frags, 
but leaving the base is permitted since situations arise when a particularly 
threatening attacker needs to be taken out.  
"Would you take a Quad rocket for your team?"  

Once the base button has been pressed every player on the attacking team claims a
ten frag bonus.  All defending players are gibbed and the player responsible for
pressing the button scores these fraggs as well.  Members of the attacking team are 
teleported into the base and keeping any items they have.  The defences are 
restored ready to start again.

Only players on the attacking team are able to press the base button.  This prevents 
any cheating made possible by defecting for the good of a team or clan.  

There are a number of additional bonus scores to reward teamplay.  These are weighted
towards the defending team to make holding the base an advantage.  

Some bases may be equipped with motion sensors which upon detecting an attacking 
player in their immediate vicinity will warn all defending players, it may also 
give the location of the intruder, however, it will not give any indication to the 
number of enemy players present.  Bases may also be equipped with button 
activated weapons.  

The defending team receive an extra item - the universal repair device, or URD - 
with which they can repair their wall.  

Upon a level change the two teams will swap roles.


Server Configuration
--------------------

Quake II Base Defence is a simple add on to the server.  All of the normal
server deathmatch options apply, with the following additional options:

        DF_FORCEJOIN		131072	
        DF_ARMOR_PROTECT	262144
        DF_FAST_SWITCH      	524288


The DF_FORCEJOIN option will cause players joining the server to
automatically be assigned to a team (no menu or spectator mode is available).
DF_ARMOR_PROTECT may be set to cause your attacks to not harm teammates' armor.
DF_FAST_SWITCH turns on fast weapons switching (similar to the weapon switching
in rocket arena II).

        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_INFINITE_AMMO        8192
        DF_QUAD_DROP            16384
        DF_FIXED_FOV            32768
        DF_FORCEJOIN		131072	
        DF_ARMOR_PROTECT	262144
        DF_FAST_SWITCH     	524288

For example, say you wish to configure a server with weapons stay, instant
items, spawn farthest, force respawn, quad drop, and armor protect, you would
use:

        4 + 16 + 512 + 1024 + 16384 + 262144 =   280084

Then you would run the server as:

        quake2 +set game q2bd +set dmflags 935444 +map q2bd1

(add a +set dedicated 1 for dedicated servers).

A sample server.cfg file is included for server operators that set default
modes.  Server operators just run:

        quake2 +set game q2bd +exec server.cfg

Add a "+set dedicated 1" to the command line for dedicated servers.

For configuration of the teams and bonuses a .ini file is used.  An example is 
included with the patch, and a detailed explanation of its use given on the web site.


Quake II Base Defence Levels
----------------------------

There are 3 new levels in this release.

q2bd1 - Echus Overlook
q2bd2 - Lava Pits and Lasers
q2bd3 - The Omega Defense

All three were created with the Quest editor.
Further details can be found on the web site.

Level creators would be welcome on the base defence team.  An entities file for Q2BD 
will be made available on the Quest home page, and a guide to creating Q2BD compliant 
levels is available on the Q2BD web site.


History
-------

Version 0.80
First public releace of Q2BD.  Intended as a three level preview of the patch.

Version 0.30
First releace of Q2BD, kept private to members of the development team.


Copyright and Distribution Permissions
--------------------------------------

Authors MAY use these modifications as a basis for other
PUBLICALLY available work.

You MAY distribute this patch over any electronic distribution network.  You MAY NOT charge
money for this patch other than to cover the cost of the distribution.

You MAY set up Internet servers running this beta version, but please look out for the 
release version since this will no doubt contain more levels and better balanced game play.

Tom 'Lab Rat' McKeown clams no responsibility for the correct spelling of defence/defense, 
nor color/colour and will take NO undue action to change any occurrence of one to the other.
Comments on any other part of this patch are welcome.
