------------------------------------
Clan CTF
by Stephen 'AFFiNiTY' Ely
affinity@planetquake.com
http://www.planetquake.com/gamersed/
------------------------------------

1) Overview
===========

    Nearly every  time my clan went to  play a CTF match  against another
clan, someone would enter the game when they shouldn't.  Then they'd have
to reconnect, and that meant everyone had to wait.  So I decided to write
a quick hack to Zoid's CTF code  to give an admin some  control over this
process and make clan matches a bit easier.


2) Installation
===============

    Because  Clan CTF  is not  much more than a hack on  Zoid's CTF code,
and because it is server side only, your best bet is to just back up your
old ctf  gamex86.dll and put the new one with  clan support in its place.
If you're really stubborn though, go ahead and create a new directory for
it and copy your CTF .pak  into that directory.  You'll  also have to let
anyone  that connects to your server know that they'll have to copy their
.pak over to that directory as well.


3) Running the Server
=====================

    Running the server  is very simple and can  be done from the  command
line, or from  the console.  There are two  new console variables and two
new console commands.  To set the console variables from the command line
start Quake 2 like this (everything is one line):


    c:\quake2\quake2.exe +set game clanctf +set dedicated 1
        +set clan_ctf 1 +set admin_pass <password>
        +set deathmatch 1 +map q2ctf1


    Or you  can  just start up  Quake 2, switch  to Clan CTF  with  "game
clanctf",  enable  clan  support  with  "clan_ctf 1", and set  the  admin
password  with  "admin_pass  <password>",  substituting  <password>  with
whatever password you would like to use.


4) What You Need to Know
========================

    Like I said  before, there are  two new console variables and two new
console  commands.  The  first  variable is "clan_ctf".  This  determines
whether or not the new clan features are enabled.  The second variable is
"admin_pass" and this holds the password to use the new commands.  If you
don't set this variable you _can't_ use the  new commands  which are kind
of the whole point of this mod.

    The first  console  command  is "startmatch".  It  is used by  typing
"startmatch  <password>".   For   <password>  type  whatever  is  set  to
"admin_pass" which  you should  already know, otherwise you  shouldn't be
trying to start the match.  The other command is "abort", which just
aborts the countdown if you need to hold off for a minute.  That requires
entering the password just like "startmatch".

    The general process of using this mod for a match would go like this.
First, get everyone to join and set their teams like a normal game.  They
will show up on the scoreboard under  the appropriate team, but they will
still be in observer mode.  Then whoever is going to admin the match will
start the game with  the "startmatch" command  as described above.   Play
from there just like a normal game.

    As before,  all  these features  are toggleable  with the  "clan_ctf"
variable.  The  only feature  that will  still apply  is that Zoid's "id"
feature  will automatically  be turned on.   This just saves everyone the
trouble of turning it on themselves.  Besides, who _doesn't_ use this?


5) Disclaimer
=============

    Blah blah blah, I'm not responsible  for any harm  done to you,  your
computer, your cat, your mental  state, your hair folicles, or any  other
thing  that  could  ever  possibly  be affected  by  this mod.  Nor am  I
responsible for any floods, earthquakes, fires, riots, suicides, murders,
maiming, disembowelments, lacerations, acts of  God, or any other natural
or unnatural accident.


6) Other General Info
=====================

    I will  seriously say that  this was a very quick mod thrown together
in  about a  day and  testing was  very limited.   I'm not an experienced
coder either so there's bound to be something wrong with it.  Test it out
before you try it out in a serious match and please let me know about any
problems or any bugs you find.  If it turns out this is actually cool and
you folks find it useful let me know and I may continue work on it.  It's
a very quick and dirty solution that could be  done a bit more gracefully
if  given the  time.  I  just thought  I'd throw  this out to you so that
anyone with  the same problem as me would  have a way to conduct clan CTF
matches a bit more easily.

    I've  rambled  on for long  enough  so if  you have any  questions or
comments go ahead and send them to affinity@planetquake.com.  by the way,
 I think  I'll  plug  my clan  now.  Go  Elite Strike!   Check us  out at
http://es.eqclans.com/  and challenge  us if  you've got the balls.  Your
mother is a dirty whore.  What?  You're still reading?   Wow, didn't know
anyone actually read a readme this far.  Nice job.