ETQW competition 1.0

README

======================================================
ENEMY TERRITORY: QUAKE WARS(TM) COMPETITION MOD README
======================================================

THIS IS AN UNSUPPORTED RELEASE. USE AT YOUR OWN RISK.

-------------------------
I. OVERVIEW
-------------------------

The Enemy Territory: QUAKE Wars Competition Mod allows tournament organizers to easily implement and enforce specific rule-sets and enhances other competition related features of the game, such as ETQW:TV. It does this by providing additional Cvars and commands to both the players and server admins.

-------------------------
II. INSTALLATION
-------------------------

For OS specific installation instructions, please read the following appropriate section. Once the competition folder is in place, you can run the mod by loading up the game normally and selecting 'Competition' from the Mods menu.


1. Windows XP/Vista
====================

Extract the zip file and place the competition folder in your Enemy Territory - QUAKE Wars folder, which by default is located here:

	C:\Program Files\id Software\Enemy Territory - QUAKE Wars\

With Windows Vista may need administrator access to be able to install the competition folder in the Program Files. If you don't have admin access you can install the Competition Mod in your User directory instead. Simply copy the competition folder here:

	C:\Users\<USERNAME>\Documents\id Software\Enemy Territory - QUAKE Wars\


2. Mac OS
==========

Simply drag the extracted competition folder into your Enemy Territory - QUAKE Wars folder


3. Linux
=========

Extract the zip file and place the competition directory in your Enemy Territory - QUAKE Wars folder, which by default is located here:

	/usr/local/games/etqw/

If you don't have permissions to write here (usually requires root) then you can install the mod in your home directory by placing the competition directory in:

	~/.etqw/


-------------------------
III. KNOWN ISSUES
-------------------------

- None

-------------------------
IV. INSTRUCTIONs
(taken from http://wiki.splashdamage.com/index.php/Enemy_Territory:_QUAKE_Wars_Competition_Mod_Guide)
-------------------------

    * 1  Server Rules
    * 2  Weapon and Upgrade Unlocks
    * 3  Class, Weapon and Deployable Limits
          o 3.1 Class Limits
          o 3.2 Weapon Limits
          o 3.3 Engineer/Constructor Turrets
          o 3.4 Field Ops/Oppressor Artillery
          o 3.5 Covert Ops/Infiltrator Radar
          o 3.6 Mines
          o 3.7 Example Server Config
    * 4  Pausing and Time Outs
    * 5  Spectating and 'Spec Labels'
          o 5.1 Spectate Position
          o 5.2 Other spectate commands
          o 5.3 Example spectator config
          o 5.4 Spec Labels
    * 6  Vampire/Violator Team Charge Bar
    * 7  Signed Configs
    * 8  Alternate Vehicle Spawns
    * 9  MCP and Third Eye Camera Radar
    * 10 Leaning
    * 11 Useable Vehicle Limits
    * 12 General Changes
          o 12.1 Force Limbo Spectate
          o 12.2 setSpawnPoint Commands
          o 12.3 Auto Demo Recording and Screenshots
          o 12.4 Separate Vehicle Sensitivity Settings
          o 12.5 Look at Killer/Medic




1. Server Rules
================

To run Competition Mod rules on a server you'll need to set si_rules to sdGameRulesCompetition


2. Weapon and Upgrade Unlocks
==============================

Some weapons and proficiency upgrades can be unlocked for all players from the match start in Competition Mod, despite proficiency being turned off. Setting the following Cvars to 1 will unlock these weapons and upgrades.

g_unlockGrenadeLauncher ? unlocks the Grenade/Plasma Launcher for the Engineer/Constructor
g_unlockScopedRifle ? unlocks the Scoped Assault Rifle/Accurised Lacerator for the Field Ops/Oppressor
g_unlockExtraClip ? unlocks extra ammo for all player classes
g_unlockFasterSprint ? unlocks faster movement speed for all player classes
g_unlockWeaponSpread ? unlocks reduced weapon spread for all weapons



3. Class, Weapon and Deployable Limits
=======================================

Competition Mod also allows admins to set restrictions on the number of classes and deployables available to a team, as well as limiting some weapon types. The value placed against any of the following Cvars is the maximum number of that game element allowed. A value of -1 means there is no limit.


3.1 Class Limits
-----------------

g_maxSoldiers ? sets the number of GDF Soldiers allowed
g_maxMedics ? sets the number of GDF Medics allowed
g_maxEngineers ? sets the number of GDF Engineers allowed
g_maxFieldOps ? sets the number of GDF Field Ops allowed
g_maxCovertOps ? sets the number of GDF Covert Ops allowed
g_maxAggressors ? sets the number of Strogg Aggressors allowed
g_maxTechnicians ? sets the number of Strogg Technicians allowed
g_maxConstructors ? sets the number of Strogg Constructors allowed
g_maxOppressors ? sets the number of Strogg Oppressors allowed
g_maxInfiltrators ? sets the number of Strogg Infiltrators allowed


3.2 Weapon Limits
------------------

g_maxGPMGs ? sets the number of GPMGs/Hyperblasters allowed per team
g_maxRocketLaunchers ? sets the number of Rocket Launchers/Obliterators allowed per team
g_maxSniperRifles ? sets the number of Sniper Rifle/Railguns allowed per team
g_maxHeavyWeapons ? limits the total number of GPMGs/Hyperblasters and Rocket Launchers/Obliterators allowed per team
g_maxGrenadeLaunchers ? sets the number of Grenade/Plasma Launchers allowed per team


3.3 Engineer/Constructor Turrets
---------------------------------

g_maxAITs ? sets the number of Artillery Interceptor Turrets allowed per team
g_maxAPTs ? sets the number of Anti-Personnel Turrets allowed per team
g_maxAVTs ? sets the number of Anti-vehicle Turrets allowed per team


3.4 Field Ops/Oppressor Artillery
----------------------------------

g_maxArtillery ? sets the number of Artillery/Rail Howitzers allowed per team
g_maxHammers ? sets the number of Hammers/Dark Matter Cannons allowed per team
g_maxRocketArtillery ? sets the number of Rocket Artillery/Plasma Mortars allowed per team


3.5 Covert Ops/Infiltrator Radar
---------------------------------

g_maxRadars ? sets the number of Radars/Psi-Radars allowed per team


3.6 Mines
----------

g_maxMines ? sets the total number of mines a team is allowed to have deployed at any one time


3.7 Example Server Config
--------------------------

This is an example of a server config file limiting deployables, weapons, class, and mines:

// **************************************************************
// *******                                               ********
// *******  Example class, dep and weapon limits config  ********
// *******                                               ********
// **************************************************************


// Turret restrictions

set g_maxAITs 1			// Allows 1 Artillery Interceptor Turret per team
set g_maxAPTs 1			// Allows 1 Anti-Personnel Turret per team
set g_maxAVTs 1			// Allows 1 Anti-Vehicle Turret per team


// Artillery Restrictions

set g_maxArtillery 1		// Allows 1 Artillery or Rail Howitzer per team
set g_maxRocketArtillery 1	// Allows 1 Rocket Artillery or Plasma Mortar per team
set g_maxHammers 1		// Allows 1 Hammer or Dark Matter Cannon per team


// Weapon Restrictions

set g_maxRocketLaunchers 1	// Allows 1 Rocket Launcer or Obliterator per team
set g_maxGPMGs 2		// Allows 2 GPMGs or Hyperblasters per team
set g_maxGrenadeLaunchers -1  	// Allows unlimited Grenade Launchers per team if the Grenade Launcher is available
set g_maxHeavyWeapons -1	// Set no limit to Heavy Weapons
set g_maxSniperRifles 1		// Allows 1 Sniper Rifle or Rail Gun per team


// Mine Limit

set g_maxMines 8		// Allows each team to only have a maximum 8 mines deployed at one time


// Radar Limit

set g_maxRadars 1		// Allows each team to deploy only 1 Radar at a time


// Strogg Class Limits

set g_maxAggressors 2		// Limits Strogg to 2 Aggressors at any one time
set g_maxTechnicians 2		// Limits Strogg to 2 Technicians at any one time
set g_maxConstructors 3		// Limits Strogg to 3 Constructors at any one time
set g_maxOppressors 2		// Limits Strogg to 2 Oppressors at any one time
set g_maxInfiltrators 2		// Limits Strogg to 2 Infiltrators at any one time


// GDF Class Limits

set g_maxSoldiers 2		// Limits GDF to 2 Soldiers at any one time
set g_maxMedics 2 		// Limits GDF to 2 Medics at any one time
set g_maxEngineers 2		// Limits GDF to 2 Engineers at any one time
set g_maxFieldOps 4		// Limits GDF to 4 Field Ops at any one time
set g_maxCovertOps 1		// Limits GDF to 1 Covert Op at any one time


4. Pausing and Time Outs
=========================

Further support has been added for pausing matches as well as a new Team Timeout feature. Any player on either team can call a time out at any time during a game (if allowed on the server), this will pause the game for a set amount of time before counting the game back in and restarting it. Related Cvars and Commands are listed below.

admin pause ? Command to pause a game indefinitely
admin unpause ? Command to un-pause a game
g_unpauseTimer ? Sets the duration, in seconds, of the match restart countdown that plays after a pause or time out has ended
g_maxTeamTimeouts ? Determines how many timeouts a team can use per match, value of -1 turns timeouts off
g_teamTimeoutLength ? Sets the duration, in minutes, a timeout will last
callTimeout ? Command used to start a timeout, any player is able to call a time out



5. Spectating and 'Spec Labels'
================================

With Competition Mod spectators are now able to view players in free fly mode with much greater control and feedback. Support