			       Paintball 2.0
			      by Digital Paint

			Server Side Documentation

Email        : Arthur Tomlin, calrathan@captured.com
Website      : http://qteam.stomped.com

Table of Contents

   I.    Overview 
   II.   Server options
   III.  Remote Administration of a Paintball server
   IV. SERVER / ADMIN COMMANDS

I. Overview

   This document describes how to setup as a Paintball2 Quake server. If you
   do not already know what a Quake2 server this document probably does not
   apply to you. This document assumes that the reader is familiar with
   running Quake2 and Quake2 servers, setting command line options, and the
   differences between client side and server side. 

   If all you want to do is play Paintball over the internet then you only
   need to read client.txt that came with the game. If you aren't yet
   familiar with Quake2, please review the documentation that came with Quake2
   first.

II. Server Options

   Paintball allows the server owner and operators to change many aspects 
   of its operation, hrough the command line interface, the server.cfg;
   which is a list of server commands to run on server start, commands.cfg
   which will set the levels required for commands, motd.cfg which will
   contain the message of the day for your server, and also the rotation
   configuration files, which controls map rotation.  Settings changed
   through remote adminstration options only last until the server goes down
   so this is not meant for permanent settings.

   If you want permanent settings then these options need to be passed using
   console variables (via command line or server.cfg). 

   Quake2 server administrators should also consult the sample 
   server.cfg provided for additional server settings for Paintball2.

   A) Command line parameters

   "+set debug1 1"

	This command will run the server in single player mode.  This allows
    for people to run around in the levels by them selves. This mode was
    designed for map makers to test the aspects of their maps.

   B) Server .CFG options   
	

III. Remote Administration:

   Names
   -------

   People in the game are either ops or peons.  Typing NAMES in
   the game, will display who is an op, and who isn't.  Ops can have
   a level between 1 and 32767, but it is reccomended to use only
   1 - 255.

   ]names
   1] * OP 250, Calrathan
   2] * OP 100, Jitspoe
   4] * OP 50, SmokeYa
   5] * OP 0, TX_Outlaw

   The * is a "splat" of the color of the team the client is on.
   the # to the right of "OP" is the level the client is opped at.
   The reason the listing of people may skip a number, in this case
   number 3, is that each client is assigned a number when they connect.
   If client #3 disconnects in the middle of a game, such an occurance as
   the example above may happen.


   Login
   -------

   In all these commands, you can either enter the name, or the number.

   To gain ops in a game, you must use the LOGIN command :

   ]login DP_Owns  
   You are now opped at level 100

   This will give you ops. The passwords are set in the server.cfg file
   and are case sensitive

   cvar_set
   -------
   
   This is a command which will allow an op to set a variable on the 
   server.  It can be used to alter the timelimit and fraglimit

   ]cvar_set timelimit 20
   setting timelimit to 20

   This works the same way as typing "set timelimit 20" at the server 
   console

   kck
   -------

   Kick those annyoing players off the server.

   ]names
   1] * OP 250, Calrathan
   2] * OP 100, Jitspoe
   4] * OP 50, SmokeYa
   5] * OP 0, TX_Outlaw

   ]kck 1
   Calrathan was kicked
   Calrathan leaves team red
   Calrathan disconnected

   newmap
   -------

   Change the map to a new one. Easy enough.

   ]newmap koth

   Simple and self explanitory

   viewkick
   -------

   This command when issued will cause anyone within your crosshairs
   to be kicked from the server.

   viewgib
   -------

   This command when issued will cause anyone within your crosshairs
   to be killed.

   givewarning
   -------

   This command when issued will cause anyone within your crosshairs
   to be given a warning to cease behavior or be kicked
   

IV. SERVER / ADMIN COMMANDS

   The following commands work both through remote admin and also
   from the server console.  To use them from the server console, 
   prefix the commands with "sv".  

   ex. "sv grenades smoke 1" 

   From the server console this will set 1 grenade per team.

   grenades
   -------

   type this followed by the tpye then the number.
   the format is "grenades [smoke/paint] #" where the number is
   from 0 to 10. 0 will turn off grenades of that type.  This
   is the number of grenades per team.
  
   expert
   -------

   We've all heard of expert quake... or have we? 
   This mode forces every gun in the map to spawn as the same
   type.

    Usage: "expert #", where # is the type of gun. 0 cancels
	1: Trracer    5: Carbine    
	2: Stingray   6: Autococker 
	3: Vm-68      7: Automag    
	4: Spyder     8: Pgp        

   autojoin
   -------

   ]autojoin on 	// Turns autojoining teams on  
   ]autojoin off	// Turns autojoining teams off
   ]autojoin ping       // Join teams by ping

   ffire
   -------

   ]ffire on 		// Turns autojoining teams on  
   ]ffire off		// Turns autojoining teams off

   rotation
   -------

   ] rotation help
	------------------------------------- 
	usage: 
	ROTATION <filename> [<rot type>] 
	  <filename> - server ini file 
	  <rot_type> - 0 = sequential (def) 
	               1 = random 
	               2 = vote 
	ROTATION START to go to 1st map 
	ROTATION NEXT to go to next map 
	ROTATION GOTO # to jump to a map 
	ROTATION to display current list 
	ROTATION OFF to clear/disable 
	ROTATION ON to reload default rotation 
	ROTATION HELP for this screen 
	------------------------------------- 

   sequential runs thru the maps in order
   random picks a random map every time
   vote lets the clients vote between the maps

   ex.
   ]rotation pball/rotation.cfg 0 
   ]rotation pball/voting.cfg   2 
   
   
