1. Introduction
2. Features
3. Server Modes
4. Server CVars
5. Commands

For those of you that have never heard of a "Ring" mod for Quake, I will explain what this mod is for. Have you ever tried to run a 3 on 3 game in Quake 2? Have you had to tell people to suicide so they aren't packing all the weapons and ammo? Now what do you do about that negative frag count? And what is that guy in the Snork model doing standing by the BFG waiting for someone to broadcast "GAME ON!" so the match can begin?

This mod is about creating a controlled environment for match play in the Quake 2 game. The most important thing is that the mod not interfere with normal Free-For-All games and only come into play when needed as a match/teamplay server.

Many of the server functions are controlled by individuals that have Admin status on the server. If there are no Admins around, an Admin can be elected from the current players. The important things to configure for a match are the time limit, what powerups will be available, and what team everyone is on. After that, everyone declares that they are ready and the server counts down to the start of the match. Details on the two server modes are listed below.

• runs normally as a Free-For-All server
• customizable two line Message Of The Day
• Admin control of powerups and Match time limit
• Admin can be elected from current players
• server can be locked down while a Match is being set up
• optional respawn protection
• disable of any weapon or powerup in either FFA or Match mode
• Match scoring handled automatically
• up to 16 teams in Match mode
• team names up to 12 characters long
• Match times from 5 to 60 minutes
• items picked up in the waning seconds of a match, respawn when the match ends

• FFA - Free-For-All

  For the most part, Q2Comp does not interfere with a server in FFA mode. It lets the normal Quake time and frag limit settings and skin/model settings control how the server and players act. To switch the server out of FFA mode and into Match mode, you need to be an Admin.

• Match - Team Competition

  When a Q2Comp server is in Match mode, there are actually three distinct segments of Match mode: pre-Match rally time, counting down to the Match, and Match in progress.
  
  While the server is in either pre-Match rally time or counting down to a Match, players are not able to pickup any items, nor able to damage one another. Consequently, players that become stuck in lava, slime, water, or under platforms, will take no damage and may need to suicide in order to remove themselves from that situation. It is during this time that someone with Admin status should be configuring the server for the upcoming match by setting the time limit, powerups, and other details. It is up to the individual players to set their teams and make sure that others on the team have selected the same team name.
  
  Once everything is configured, players can begin declaring themselves ready for the match. Up until the last second before a match starts, any player can declare him/herself not ready, and stop the countdown. When the match begins, every player is gibbed (to remove all weapons and powerups) and his/her score reset to zero.
  
  The match begins and all players are goverend by a combination of server and Match settings. The server displays the time remaining in the match every minute as well as does a countdown of the remaining seconds. When the time is up, every player is gibbed, a winner is declared (or a list of the tying teams), and the server resets back to pre-Match rally mode.

These CVars can be changed at anytime at the server's console.

• admincode - default = "qwerty"

  "admincode" holds the code that a normal player must enter in order to become an Admin. This CVar can hold letters or numbers and defaults to "qwerty" if no admincode is specified. See the admin and elect commands.

• adminkick - default = 3

  "adminkick" is the number of invalid attempts that a normal player can try for the Admin code using the admin command before being kicked from the server. It defaults to 3 if this CVar is not set. See the admin and elect commands.

• adminname - default = ""

  Enter the name/nickname of the server's administrator in "adminname". This will be displayed by the "contact" command.

• e-mail - default = ""

  Enter the e-mail address of the server's administrator in "adminname". This will be displayed by the "contact" command.

• fastweap - default = 0 - valid = 0 or 1

  If you want to enable Fast Weapon switching, set "fastweap" to 1. The default of 0 is normal Quake 2 weapon switching speed.

• ffadisable - default = 0

  The CVar "ffadisable" holds a number that determines what weapons and powerups are to be disabled in FFA mode. The following are the items and their numeric values, similar to DM Flags.
  
  

  Quad	1
  Invulnerability	2
  BFG	4
  RailGun	8
  HyperBlaster	16
  Rocket Launcher	32
  Grenade Launcher	64
  Grenades	128
  ChainGun	256
  Machine Gun	512
  Super Shotgun	1024
  Shotgun	2048

  
  The numbers are added together and will affect the items on the level. If this value is changed, then the server must be restarted. For example, to disable the Quad, Invulnerability, and BFG, you would set "ffadisable" to (1 + 2 + 4 =) 7.

• initialmode - default = "ffa" - valid = "ffa" or "match"

  To set the initial mode of the server, set "initialmode" to either "ffa" for Free-For-All mode or "match" to start in Match mode. If nothing is specified, or an invalid mode is specified, the server will default to FFA mode. To switch between the FFA and Match modes, see the modeset command.

• lockcurrmode - default = 0 - valid = 0 or 1

  If you want to lock the server into Match mode, set this CVar to 1. When the server is in Match mode and no matches or level changes happen for 10 minutes, the server will reset to FFA mode. Set to 1, it will reset back to Match mode. This CVar has no effect on FFA mode.

• logging - default = 0 - valid = 0, 1, or 2 - NOT FUNCTIONAL

  NOT FUNCTIONAL

• matchdisable - default = 0

  The CVar "matchdisable" holds a number that determines what weapons and powerups are to be disabled in Match mode. The following are the items and their numeric values, similar to DM Flags.
  
  

  Quad	1
  Invulnerability	2
  BFG	4
  RailGun	8
  HyperBlaster	16
  Rocket Launcher	32
  Grenade Launcher	64
  Grenades	128
  ChainGun	256
  Machine Gun	512
  Super Shotgun	1024
  Shotgun	2048

  
  The numbers are added together and will affect the items on the level. If this value is changed, then the server must be restarted. For example, to disable the BFG, RailGun, and HyperBlaster, you would set "matchdisable" to (4 + 8 + 16 =) 28.

• motd1 - default = "Welcome!"
• motd2 - default = ""

  "motd1" and "motd2" hold the two Message Of The Day lines. If you set these to more than about 40 characters in each line, they will be chopped off. See the "motd" command.

• noelect - default = 0 - valid = 0 or 1

  Setting "noelect" to 1 disables the elect command. If this CVar is not set, it defaults to 0. See the elect command.

• nolockdown - default = 0 - valid = 0 or 1

  Setting "nolockdown" to 1 disables the "lockdown" command. If this CVar is not set, it defaults to 0. See the lockdown command.

• nowarp - default = 0 - valid = 0 or 1

  To disable the warp command, set the "nowarp" CVar to 1.

• protect - default = 0 - valid = 0+

  If you want to enable give each player a number of seconds of Invulnerability after they respawn, set the "protect" CVar to a positive number representing the number of seconds.

• scorecast - default = 0 - valid = 0 or 1

  Setting "scorecast" to 1 broadcasts the current scores of the teams/clans in the current match every minute.

• vwep - default = 0 - valid = 0 or 1

  Setting "vwep" to 1 enables the El Nino/Visible Weapons code.

• admin code - [---]

  The "admin" command is used when a player wants to become an Admin and knows the Admin code. If you enter the Admin code incorrectly, you are warned, and the server begins to count the invalid attempts. If your invalid attempts are greater than the CVar adminkick, you will be kicked from the server. If you are succesful, you will be granted Admin status and all players on the server will be notified. Admin status lasts for the current level. If the level changes or the server is reset, all Admins will be reset.

• commands - [---]

  This command will list all valid Q2Comp commands and a short description of each.

• contact - [---]

  "contact" will display the server administrator's name and e-mail address using the adminname and email CVars.

• credits - [---]

  This command will display a list of credits for the Q2Comp mod.

• dropquad on/off - [AM-]

  While setting up a Match or FFA, you can set the DropQuad DM Flag. This take place instantly and does not require a server restart. For those of you who don't know, when DropQuad is on and a player is killed and he/she has Quad, it drops like a weapon with the remaining time left for anyone to pick up.

• elect - [-MF]

  To gain Admin status when there are no Admins around, type "elect" at the console to begin the voting process to become elected an Admin. Other players shoudl vote "yes" or "no" at the console. A "yes" vote is automatically cast for you. If more than 50% of the current players vote yes, you will be granted Admin rights. In the event of a tie, the vote is defeated. If you succeed, you will be granted Admin status and all other players will be notified. Admin status lasts for the current level. If the level changes or the server is reset, all Admins will be reset.

• endmatch - [--F]

  "endmatch" starts a vote to end the currently running match. This comes into play when a match gets started and the players notice that a setting is not correct.

• ff on/off - [AM-]

  The Friendly Fire DM Flag controls whether or not you can harm teammates. The "ff" command allows an Admin to set this DM Flag. With Friendly Fire "on", you can harm teamates. With Friendly Fire "off", you cannot harm teamates. Either way, you can still hurt yourself.

• lockdown on/off - [AMF]

  Lockdown is used to prevent players from connecting to the server while a Match is being set up. This is useful when you have the teams all set up and you don't want others connecting and unbalancing the teams. You must specify "on" or "off". This command can also be issued from the server console by prefacing it with the word "sv".

• matchfragset value - [AMF]

  "matchfragset" is used to directly set the Match fraglimit while the Match is being set up. You can set the Match fraglimit to any integer value between 0 and 200 frags. 0 frags means there is no fraglimit. This command can also be issued from the server console by prefacing it with the word "sv".

• matchtimeset value - [AMF]

  "matchtimeset" is used to directly set the Match timelimit while the Match is being set up. You can set the Match time to any integer value between 5 and 60 minutes. This command can also be issued from the server console by prefacing it with the word "sv".

• modeset - [AM-]

  Use the "modeset" command to switch the server from FFA to Match or vice versa.

• modstatus - [---]

  "modstatus" displays the current status of the Q2Comp mod.

• motd - [---]

  "motd" displays the Message Of The Day to your screen.

• myscore - [--F]

  "myscore" displays your frags, enemy kills, friendly kills, and deaths.

• no - [---]

  This commands casts your vote as "no" to the current vote.

• normal - [A--]

  "normal" is used to drop your Admin status.

• notready - [-MF]

  To stop the countdown to the start of the Match, use "notready". This will stop the timer and remove you from your current team. This does not mean that you have to reset your team name, just that you are not commited to that team in case you want to change it. See the team and ready commands.

• playerlist - [--F]

  This command lists all the players, their status, team, and skin. This command can also be issued from the server console by prefacing it with the word "sv".

• powerups on/off/quadoff/invoff - [AM-]

  While setting up a Match or FFA, you can add or remove the Quad-damage and Invulnerability powerups from the map. You must use one of the four options. This command works for both FFA and Match modes. Items are not removed immeadiatly, so you must restart the server. This command can also be issued from the server console by prefacing it with the word "sv".

• ready - [-MF]

  Once you have selected your team, you can declare yourself ready for the Match. Once all the other players have declared themselves ready, the countdown to the Match will begin. You can inturrupt the countdown or change your team by first using the notready command.

• restart - [AM-]

  "restart" is normally used to apply the changes from the powerups setting to the current map. This command can also be issued from the server console by prefacing it with the word "sv".

• spectator - [-M-]

  To change from a player to a spectator, use the "spectator" command. This removes you from the game and lets you move around the current map in a "noclip" manner.

• team name - [-MF]

  Before you can declare yourself ready for a match, you must pick a team name using the "team" command. All players that pick the same team name are consodered on the same team. Team names longer than 12 characters will be chopped off. The "Friendly Fire" server DM Flag controls whether or not you can damage a teammate. Once you have declared yourself ready, you cannot change your team name unless you declare yourself notready.

• timerset n - [AMF]

  While in rally mode, you can set the Rally Timer to any value between 5 and 20 minutes. This takes place immeadiatly, so you can use this command to give yourself more time to get a match set up. This command can also be issued from the server console by prefacing it with the word "sv".

• warp map [trust] - [-M-]

  During FFA and setting up for a match, the current level can be changed with the "warp" command. If you are not an Admin, this will start a vote. If you are an Admin, the change will happen immeadiatly. Currently, the "warp" command only supports the id Quake 2 maps, DM maps, and the "match1" map. Other maps may be specified by using the "trust" parameter - eg. "warp booga trust" will make the server switch to that map and if it doesn't exist, the server will shutdown. The "trust" parameter only works for Admins that know the Admin code, not elected Admins. The "warp" command can be disabled by setting the nowarp CVar to 1.

• yes - [---]

  This commands casts your vote as "yes" to the current vote.