Title    		: Rocket Arena 4 Client Readme
Version  		: 0.5 Beta 2
Webpage			: http://www.planetquake.com/arena
Date     		: 04-2006
Document author	 	: Sub-Zero
Document version	: 1.1
Development Webpage	: http://ra4.raplanet.com

--------------------------------------
 Installation
--------------------------------------
To install, simply extract ra405b2.zip to your Quake 4 directory.  A directory called 'arena' will be created.  Then copy your Quake 4 link, get properties and add: +set fs_game arena to the 'target' field.  It should look something like this: "D:\quake4\Quake4.exe" +set fs_game arena 

--------------------------------------
 Game Overview
--------------------------------------
Rocket Arena matches are played in "arenas." Each map may have one or more arenas
in it. When you connect to a server, you need select an arena and then
either create or join a team within it.

--------------------------------------
 Crash Reports
--------------------------------------
Rocket Arena 4 is in a beta state, and may therefore sometimes crash. If this happens, two files will be saved to your arena directory. These files are named <date>.dmp, and <date>.dbg.
Please send us both of these files by either posting them on our forum at the development webpage (see above), or mailing them to ra4@raplanet.com. Please remember to describe what you were doing at the time of the crash.

--------------------------------------
 Game Types
--------------------------------------
Rocket Arena 4 currently has two different modes: Rocket arena and Clan Arena.  In Rocket Arena, two players face off in a battle to the death, being given full health, armor, and loadout of weapons (except the DMG).  The victor stays, and the loser goes to the end of the line.  Then, the next-in-line faces off against the current victor.  In Clan Arena, two teams face off in a similar manner within a full-size map.  When a player dies, he waits until every player on either team dies, declaring a team victory for that round.  Whichever team whins the majority of rounds (game votable), wins the match.

--------------------------------------
Voting
--------------------------------------
Within each arena, settings can be voted on to tailor the game to the players' liking.  The server admin may grant or rescind the options as well to tailor the game to the general tastes of his community.  Different arenas may also have differing default settings.

For Rocket Arena mode, they are:
	
	'Rounds' per match.  How many rounds are played to determine the victor
	'Players per Team.'  How many players per team
	'Armor Damage'	     Whether self-inflicted wounds 'damage' armor and/or the armor of your team.
	'Health Damage'	     Whether self-inflicted wounds 'damage' health and/or the health of your team.
	'Falling Damage'     Whether players take damage from falling or not.

In Clan Arena, Players per Team is a server-admin selectable value.  It cannot be voted on by players.  Otherwise, the voting options remain the same.
--------------------------------------
 Global Server Voting
--------------------------------------
The "clientcallvote" console command is still present and can be used for server-wide voting
(the menu voting is just for individual arenas).
The callvote commands available are:
"clientcallvote kick <name>" to vote to kick a player. Note that you can also just type
"clientcallvote nextmap" will skip to the next map
"clientcallvote map <map>" will load the map named <map>
"clientcallvote timelimit <limit>" sets global time limit for current map.
A vote will only pass if a certain percentage of the players on a server vote yes.

--------------------------------------
Client cvars
--------------------------------------
ra4_teamcolor
	Sets color of team skins as "r;g;b" (use quotes)
	"1;0;0" would be red
	"0;1;0" would be green
	"0;0;1" would be blue
	these values are normalized between 0 and 1 floating point.


ra4_enemycolor
	Same as teamColor but sets enemycolors


ra4_forcemodels
	Forces player models to those specified in ra4_enemyModel and ra4_teamModel
	Values are 0 or 1. If 0, then individual players' selections are honored.


 g_forceEnemyModel
	Sets teammodel.  For instance, "model_player_marine_morris"
	This can also be set via the in-game Settings menu.


 g_forceTeamModel
	Same as teamModel but for enemy team.


ra4_scoreboardstyle
	Loads an alternate scoreboard.  For instance, a value of "myboard" will attempt to load guis/scoreboard_myboard.gui
	These scoreboard GUI files must exist first.  No extras ship with RA4 at this time.

r_ambientOnly
    Forces the renderer to use a single pointlight to light the whole world 

ra4_hudstyle
	Same syntax as ra4_scoreboardstyle but loads an alternate HUD.  No HUD GUIs ship with RA4.


ra4_serverscript
	Sets the server's config script.


ra4_projectiletrails
	Toggles projectile trails.  0 = none, 1 = rockets only, 2 = grenade only, 3 = both (default)


ra4_forcehitscantint
	Forces railcolor to the values used for ra4_teamcolor and ra4_enemycolor


### client Commands ###

listLocations 
	Lists known map locations 

deleteLocation 
	Deletes a map location 

addLocation 
	Adds a new map location 

clientMessageMode [0,1,2] ( Default 0 ) 
	Enter message mode. Optional parameters: 0 = say, 1 = sayTeam, 2 = sayWorld. 

sayWorld 
	Send chat messages that are visible in all arenas. 

specInvite <client>
	Invites client to spectate your team in competition mode. 

specRevoke <client>
	Revoke spectator privileges from client 



--------------------------------------
Server Commands 
--------------------------------------

setArena <client> <arena> 
	Moves player to specified arena 

setTeam <client> <team> 
	Moves player to specified ACTIVE team 

arenaSetTeam <client> <team> 
	changes the arena specific team of a player 

arenaCreateTeam 
	Creates a team in specified arena 

arenaRemoveTeam <arena> <team> 
	Removes a team from specified arena 

arenaSetPPT <arena> <player> 
	Sets players per team in the specified arena 

setSpec <client> <1/0> 
	Set the spectator status of a player 

arenaSetMode <arena> <mode> 
	Sets the arena mode: 
	Lobby = 0 
	Clan Arena = 1 
	Rocket Arena = 2 

arenaSetRounds <arena> <rounds> 
	Sets the number of rounds in the specified arena 

addGuidBan <guid> 
	Adds a GUID ban 

--------------------------------------
Other Commands
--------------------------------------

These Commands are valid for client or server console

arenaListTeams 
	Lists teams in specified arena 

arenaListPlayers 
	Lists players in specified arena 

arenaVote 
	Vote on the currently proposed settings 

--------------------------------------
Credits
--------------------------------------

Programming:
	Patrik 'ElQueffo' Persson

Gui design:
	Daniel 'kanthal' Dahl

Mapping:
	Team Lead: Jamin 'Sub-Zero' Bulyk
	
	Vilhelm 'g0th' Flohr (gothra4map1)
	Justin 'Stormshadow' Ingels (stormra4map1)

Textures:
	eX texture set by Yves Allaire (evillair) http://evillair.net (stormra4map1)
