                               Hot Potato CTF 
                                Version 1.6
                                for Quake II

                            Server documentation

Email                  : Gary Griggs (cyberdog), qteam@stomped.com
Main Website           : http://qteam.stomped.com 
Hot Potato CTF website : http://www.captured.com/hotpotato

This file describes how to start a Quake II server to run Hot Potato CTF for
a multiplayer game. It assumes that you already know how to run Quake II 
deathmatch servers and only points out differences from the standard server 
configuration. If you do not know what a Quake server is then this 
documentation is not for you (read client.txt instead).

1. Starting a server
   We'll keep this pretty simple. You should already know how to start 
   a Quake II server. There's plenty of information out on the internet
   about this. This is the command line we've been using to start a
   Hot Potato server. Some of the arguments on this command line could be 
   included in server.cfg but again this just just happens to be the 
   way we've tested it.

   quake2 +maxclients 10 +set dedicated 1 +set deathmatch 1 +set game hpctf 
   +exec server.cfg +map base1

2. Server options
   2.1. Server.cfg
        Most of the server options are described in the provided server.cfg 
        template found in the hpctf directory. 

   2.2. Map Rotation
        There are only two choices, on or off. Use the standard Quake II 
        method for enabling or disabling map rotation (it's bit 5 of 
        dmflags). If map  rotation is enabled through dmflags, fraglimit 
        must also be set (timelimit is not supported in this release but 
        will be in the next). The server will rotate through all Hot Potato 
        CTF maps including the custom map. 
   
3. Remote administration
   3.1. Methods for remote administration
        There are 2 methods for remote administration of a Hot Potato server
        3.1.1. Console access/Remote console access
               This is the standard server administration provided by 
               Quake II. Using this method of control users who have local 
               console access or remote console access (i.e. either at the
               machine, telnet capabilities, QHost access, or rcon access)
               can change regular Quake II settings as well as Hot Potato
               settings.
        3.1.2. Hot Potato CTF operator
               Setting up operators for a Hot Potato server using the 
               Quake Innovations method for remote administration allows
               limited control over the server. For example a low level 
               operator can change to another Hot Potato CTF map but cannot
               shutdown the server. 
   3.1. Server.cfg
        All passwords and operator prililege level associated with each
        password are specified in server.cfg.
   3.2. Entering the password
        When you are running a client connected to a Hot Potato server you
        enter the password for op control by entering "cmd password 
        <password>" from the console. You can bind a key to this to make
        life easier.
   3.3. Operator commands
     3.3.1. cmd map <mapname>
            Loads a new Hot Potato CTF map. If an attempt is made to load a 
            map that Hot Potato CTF does not support, "The Outer Base" 
            (base1) will automatically load.
     3.3.2. cmd ffire [on | off]
            Enables or disables the ability for teammates to hurt each other.
            Regardless of whether friendly fire is enabled or disabled, a 
            player can still hurt himself.
     3.3.3. cmd soundteam [0-60]
            Enables or disables team sounds and sets the pacing.
            0 = disable team sounds
            1-60 = number of seconds between successive sounds from an
                   individual.
     



