Title    : Rocket Arena 3
Version  : 1.00 Release (Server)
Date     : 7/22/00
Author   : David 'crt' Wright <wrightd@gamespy.com>
Web Page : http://www.planetquake.com/arena
Discussion list: rocketarena-subscribe@lyris.gamespy.com

-----
Intro
-----
Please read this entire file, as it contains important info on installation.
Also, be sure to read the readme.txt included in the client package.

-------------------
Troubleshooting/FAQ
-------------------
We'll put this section at the front of the file so you'll actually find it!

Q: When I connect to my server it doesn't seem to actually be playing RA3?
or
Q: I get a client/server version mismatch when trying to connect to my server?

A: This is almost always caused by running your server with sv_pure on. RA3 requires
sv_pure to be off (since it's not compatible with native binary mods). Rest assured that
RA3 has its own cheat protection built in. You MUST run the server with "+set sv_pure 0" on the
command line.


Q: It asks for a CD when the server starts up?
or
Q: It won't load any maps?

A: Make sure you have +bot_enable 0 on the command line. RA3 does not support Q3 bots yet.


Q: I get "CLIENT_UNKNOWN_TO_AUTH" when I try to connect to my server?

A: We've seen this on a couple servers running under Linux. It appears to be
some kind of problem with the CD Key authentication. Usually it only affects
clients on the same LAN as the server (so outside people can probably play fine).
The only work around we've found is to add:
authorize.quake3arena.com
To the "127.0.0.1 localhost" line of /etc/hosts


Q: How do I change the map loop or add another map?

A: Edit the maploop line of arena.cfg (see below for more info)


Q: Can I run custom or regular Q3 maps with RA3?

A: Yes, just add them to your map loop (see below)


-------------------------
Installation Instructions
-------------------------
This is the server package for Rocket Arena 3. You will also need the client
package (a seperate download) installed on the server. Download it and install
according to the included instructions.

Extract all of the files in this package to your \quake3\arena directory.

Customize the server.cfg to your tastes. It includes the adminpass (see below)
which will allow for in-game configuration of the mod. Please change this
password!

Please see below for info on the arena.cfg file, used to customize settings
on a per server/per level/per arena basis. 
It includes map rotation information as well.

The "ra3server.bat" file (ra3server for Unix) has a sample command line for
starting an RA3 server. Note that:
1. You must set "+set fs_game arena" on the command line
2. You must set "+bot_enable 0" on the command line
3. You must set "+set sv_pure 0" on the command line

Use "+set dedicated 0" to run a Listen server (you play on the same machine)
Use "+set dedicated 1" to run a private dedicated server
Use "+set dedicated 2" to run a public dedicated server

--------------
Server Crashes
--------------
Server crashes will not be tolerated! RA3 has been designed and tested to be
a highly reliable mod. If you are experiencing server crashes. please contact
me asap so we can track down the cause. If you have physical access to the server,
the following info would be useful following a crash:
1. The full text of the "Details" box on the crash dialog
2. The text on the console at the time of crash
3. The drwatson32.log file (in your winnt directory) if on Windows NT


--------------------------
Administration / Mod setup
--------------------------
There are several console variables which control how the mod functions.
Most other options have been moved to the arena.cfg file.

"set g_adminpass mypassword" is the password that you set to allow in-game
administration of the server.

"set arenacfg myarena.cfg" will allow you to use filenames other than arena.cfg 
(to run two different servers on the same install for example).

"set location <locationcode>" will allow players to find servers by region, a list
of region locationcodes is in the sample server.cfg

"set rconPassword mypassword" sets the standard Q3 remote console password. You can use
this password with the "rcon" command to control the server remotely.

--------------
arena.cfg file
--------------
The arena.cfg file allows you to specify map options on a:
1. per server
2. per map
3. per arena
basis
Information is stored in a hierarchical format. Priority goes in order to:
1. Values for the specific arena
2. Values for that map
3. Global values defined at the top of the arena.cfg file
4. Default values stored in the game code.

The format of the file is (note that the < > characters are not typed!):
<global default option>;
<global default option>;
<mapname> {
//comment
	<map default option>;
	<map default option>;
	<map default option>;
	<arena number> {
			<arena default option>;
			<arena default option>;
			<arena default option>;
	}
	<arena number> {
			<arena default option>;
	}
}

For example:
//-----------START OF FILE------------
maploop: ra3map1 ra3map3 ra3map5 q3dm6; // <-- sets the map rotation for the server
allowvotinggrapple:1; // <-- allows people to vote for grapple on this map
ra3map1 {    // <-- ra3map1 is the map name
		weapons: 1 2 3 4 5 6 7 8; //<-- these will be the default weapons, if none are specified for an arena
		armor: 200; //<-- default health if none is specified
		health: 100; //<-- default armor
	1 {
		weapons: 1 2 3 4 5 6 7; //<-- arena 1 takes out the plasma
		armor: 100;  //<-- reduces default armor to 100
		playersperteam: 2; //<-- 2v2 matches
		rounds: 3; //<-- 2 out of 3 rounds wins the match
	}
	2 {
		weapons: 1 2 3 4 5 6 7 8 9 0; //<-- all weapons allowed
		armor: 150; //<-- only 150 armor
		health: 90; //<-- 90 health to start
		gametype: pickup; //<-- designates this as a pickup arena (will use the "defpickuparena" arena type)
		rounds: 9; //<-- 5 out of 9 rounds takes the match
	}
	3 {
		gametype: practicearena; //<<-- Changes the default gametype for this arena (from rocketarena to practicearena)
	}
	4 {
		health: 500; //<-- start with a ton of health
		armor: 500; //<-- and lots of armor
		slugs: 999; //<-- starting slugs is 999 now
	}
//you do not need to list all the maps/arenas, unlisted ones will use defaults
}
q3dm6 {
		minping: 0; //all people allowed on this map. Overrides global 150 value
		gametype: redrover; //all arenas (only 1 actually) will be redrover
		grenades: 1; //can't go crazy with hyperblaster
}

Available Options are:

weapons: 1 2 3 4 5 6 7 8;
	where the number corresponds to the default Q3 binding
health: 100;
armor: 100;
shells: 100;
bullets: 200;
slugs: 50;
grenades: 20;
rockets: 50;
cells: 150;
plasma: 100;
bfgammo: 20;
playersperteam: 1; //maximum number of players to allow on a team (for creating 2v2/3v3/etc arenas)
healthprotect: 1;
armorprotect: 2;
fallingdamage: 1;
defpickup:clanarena; //sets what type of game to have in the arenas designated "pickup". For example, changing this to "redrover" will change all the pickup arenas from clan arena to red rover.
competitionmode: 0; //enables compeition mode (can't track other team after you die)
excessive: 0; //yup
rounds: <odd numbered value>;

allowvotinggametype: 1;
allowvotinghealtharmor: 1;
allowvotingplayersperteam: 1;
allowvotingrounds:1;
allowvotinghealtharmorprotect: 1;
allowvotingweapons: 1;
allowvotingfallingdamage: 1;
allowvotingexcessive: 0;
allowvotinggrapple:0;


Please take a look at the included arena.cfg for some more examples.
If your settings are not being used, please make sure that:
1. you have a ":" (colon) seperating the identifier and the value
2. you have a ";" (semi-colon) at the end each line

------------
Game Types
------------
Rocket Arena 3 has 4 different types of games that can go on in the arenas:
"rocketarena" - 1v1/2v2/3v3 line-based gameplay
"clanarena" - 2 teams of unlimited size, no line
"redrover" - 2 teams, players switch between them when they die
"practice" - No teams, no deaths, just carnage
See the client readme for longer descriptions of each game type.

The gametype for each arena is specified by the "gametype" value in the arena.cfg.
If no gametype is specified, the default of "rocketarena" will be used. 
If the gametype is specified as "pickup" then the game type defined at the top of the file
as "defpickup" will be used. By default almost all of the RA3 maps are set up with one arena as
pickup, and the defpickup value as "clanarena". So if you want to switch your whole server over
to redrover, you just need to change the "defpickup" value.

----------------------
In Game Administration
----------------------
To use the in game administration, press esc and go to the in-game options menu.
There is a menu item for "admin". To admin a specific arena, type in your password and
double click on the arena name. It will then let you change all the settings for that arena.

To change maps, just type in the password and double click a map in the list.

-------
Credits
-------
Please see the client readme for full credits.


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

This mod is freely distributable provided that this readme is distributed
as well and is unchanged.

All code is Copyright David Wright 2000.
Rocket Arena is a registered trademark of David Wright
Commercial code licensing is available by contacting wrightd@gamespy.com

DISCLAIMER: THE PROGRAM IS DEFINED AS THE QUAKE 3 MOD "ROCKET ARENA 3" AND
  ALL FILES CONTAINED WITHIN.
  BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
  FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
  OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
  PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
  OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
  TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
  PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
  REPAIR OR CORRECTION.


------------
Availability
------------

This modification is available from the following places:

WWW   : http://www.planetquake.com/arena



---------------
Version History
---------------
1.00 (7/23/00)
Initial Release
