================================================================
 DEVASTATION Quake2 v2.0.2
================================================================
Authors                 : Devin "section8" Kelly
			  Chris "SlapHappy" Kelly
			  Blane "Xardion" Dabney
			  Michael "Efflixi" Arnold
			  James "Mr. Totoro" Lee

Homepage                : http://www.planetquake.com/devastation

================================================================


Installation Instructions:
----------------------------------


1. Download Devastation Quake2 from http://www.planetquake.com/devastation. 

2. Run the exe file, or unzip the archive to your \Quake2 folder.

INSTALLATION NOTES:

FULL INSTALL: If you are running an version of Devastation Quake2 (prior to v2.0), it is recommended that you delete the /devq2 folder. (Of course you can hold onto whatever files you have saved (cfgs, screenshots, demos, etc.) But be aware that the this install should COMPLETELY REPLACE the old devastation stuff.

UPDATER INSTALL: If you are running Devastation Quake2 v2.0 or higher, DO NOT delete that folder. This installation will only replace certain files.



Joining a Devastation Quake2 game:
----------------------------------

1. Run Quake2 with the command line parameters: "+set game devq2" (without the quotes)

i.e.
x:\Quake2\Quake2.exe +set game devq2

2. From the "multiplayer" menu, select "join network server", then enter the game host's IP address into the address book. The game will then appear in a list. Select the game.

3. Alternatively, you can use Gamespy to find all internet games playing devq2, and it will handle the command line parameters automatically upon execution. (http://www.gamespy.com)



Hosting a Devastation Quake2 game:
----------------------------------

NOTE: Before hosting a game, READ the "Server Controls" section!!! (it's not long)

1. Edit the server.cfg file located in the devq2 directory. Be sure to read it carefully!

2. Edit the maplist.txt file located in the devq2 directory.  Read IT carefully too!

3. Edit the motd.txt file located in the devq2 directory to display your personal message of the day.

For Dedicated Servers...

4. Run Quake2 with the command line parameters: "+set game devq2 +set dedicated 1" (without the quotes)

i.e.
x:\Quake2\Quake2.exe +set game devq2 +set dedicated 1

5. The console variables (listed in the "Server Controls" section) can be changed at any time in the dedicated console, be sure to restart a map for the changes to take effect.


For Non-Dedicated Servers...

4. Run Quake2 with the command line parameters: "+set game devq2" (without the quotes)

i.e.
x:\Quake2\Quake2.exe +set game devq2

5. Using the ~ key bring down the console, and set the console variables (listed in the "Server Controls" section) to your liking.

6. Then, under the "multiplayer" menu item, select "start network server", then choose a map and DM flags, and finally select "begin".

7. The console variables (listed in the "Server Controls" section) can be changed at any time in the console, be sure to restart a map for the changes to take effect.



HOW TO PLAY DEVASTATION QUAKE2:
-------------------------------

Game Modes:

When you join a game, the server will be running one of the following game modes. You can find out which mode is running at any time by looking at the top of your scoreboard (pressing F1). Listed below are the modes:

FREE FOR ALL = (gamemode 0 & friendly fire ON) - Regular deathmatch. Desecrators and/or Devastators are spawned in random locations and are obtainable by any grunt. Shoot anything and everything that moves.

DEVASTATORS vs. GRUNTS = (gamemode 0 & friendly fire OFF) - Grunts cannot damage damage fellow Grunts, and Devastators cannot damage Devastators. Messagemode2 works between grunts, and also between Devastators, allowing for planned attacks/ambushes etc. Desecrators and/or Devastators are spawned in random locations and are obtainable by any grunt. Desecrators only follow humans, so Devastators should beware.

ANNIHILATION = (gamemode 1) - ALPHA Team vs. BRAVO Team. Desecrators and/or Devastators are spawned in random locations. Each team has their own set of Devastators and/or Desecrators of which only grunts from the corresponding team can obtain. Teams battle it out for the most total frags. Suiciding DOES NOT count against the overall team frag tally.

ELIMINATION = (gamemode 2) - ALPHA Team vs. BRAVO Team. Similar to Action Quake2 teamplay, the game is round (battle) based. When you first join a server, you will be a spectator. From there, you must join a team (if you aren't put on one automatically by the server). Each team has a certain number of Devastators and/or Desecrators allowed for the match. An Equipment menu will appear where players can choose who takes what equipment into battle. Beside each selection is the (number in use/number allowed). IF THE MAXIMUM NUMBER OF THAT PARTICULAR ITEM IS IN USE, YOU WILL NOT GET IT NEXT BATTLE. Watch the messages to be sure it didn't say that all of that item is ALREADY IN USE. Selections are as follows:

DevastatorCG - You will spawn into the battle with a Chaingun Devastator.
DevastatorRL - You will spawn into the battle with a Rocket Devastator.
Desecrator - You will spawn into the battle near a Desecrator which will follow and protect you. You'll have some weapons and a little armor to start.
Grunt - THIS IS THE DEFAULT when all else is used or nothing is chosen. You will spawn with a plethora of weapons, and a good amount of armor.

Once there are players on both teams, there is a 20 second pause while players select their equipment from the equipment menu. Equipment can be rechosen at any time during the game by pressing TAB.

After the 20 seconds, a 5 second warning countdown occurs, and then the battle begins. You will be spawned in approximately the same area as your teammates equipped with what you chose from the equipment menu. From there you must locate and destroy the entire opposing team. (Desecrators need not be destroyed, only their owners). Once a team is completely wiped out, the battle is over, and the team with at least one survivor will be the victor. A point will be awarded to the victorious team for each battle won.

When you are killed, you are DEAD for that battle, and you will become a spectator until the battle is over. You cannot talk to anyone that is alive while you're dead. (why? because you could inform your teammates of the location of enemies, since you are a spectator)


Server Controls:

Console variables can be modified by the server admin by simply typing the name of the variable followed by a value. The names of Devastation Quake2's console variables (so far) are as follows:

gamemode

gamemode "0" with Friendly Fire ON = Deathmatch Free-For-All (FFA), everyone can damage everyone else.
gamemode "0" with Friendly Fire OFF = Devs vs. Grunts. Teamplay. Exactly what it says.
gamemode "1" with Friendly Fire ON/OFF = Annihilation Teamplay (Devs/Grunts vs. Devs/Grunts) 2 teams.
gamemode "2" with Friendly Fire ON/OFF = Elimination Round-based Teamplay (Devs/Grunts vs. Devs/Grunts) 2 teams.


devcg

devcg [value] = (Where [value] is a number from 1-16) Specifies how many DevastatorCG will be available on the level for pickup. The map must me restarted for the new setting to take effect.


devrl

devrl [value] = (Where [value] is a number from 1-16) Specifies how many DevastatorRL will be available on the level for pickup. The map must me restarted for the new setting to take effect.


des

des [value] = (Where [value] is a number from 1-8) Specifies how many Desecrator's will be available on the level for pickup. The map must me restarted for the new setting to take effect.


voting

voting 0 = Clientside voting disallowed.
voting 1 = Clientside voting allowed (see also "vote" in the Client Controls section).


autoteam (For Annihilation & Elimination modes ONLY)

autoteam 0 = Players select team via menu upon connection
autoteam 1 = Players automatically join team with lesser players. If teams are even, join team with lesser score.


winlimit (For Elimination mode ONLY)

winlimit [value] = Where [value] is a number that specifies how many battle wins dictates a match victory, and consequently a map change.


logging

logging 1 = Statistical logging wil occur for each time a server is run. The output will be written to "log.txt" in the /devq2 directory. Useful for server admins to find out who's got da skillz.
logging 0 = No logging will occur, and log.txt will NOT be generated.

The contents of log.txt can be read as the following:
-,<map bsp name>, <map name>
<win limit>, <time limit>, <frag limit>
<player team>, <player name>, <score>, <devs killed>, <des killed>, <grunts killed>, <frags with dev>, <frags with des>, <frags with grunt>
(NOTE: all players will be listed line by line...)
*, <time and date of level end>



Client Controls: 

NOTE: ALL Client controls are optional, they can be bound to keys or typed in the console.


id

id = Toggle Player Identification. Player Identification simply displays on your hud the name (and model/skin) of the player that's currently in your targeting reticle.


vote

"vote [flag] [value] ..." = A Clientside vote for the players to decide on what type of game will be played. To initiate a vote, bring down the console (using the ~ key) and type "vote", followed by a flag, followed by a value.

Flags:

gamemode = Specifies the type of game to be played. (legal values 0,1,2)

ff = Specifies Friendly fire on or off. (legal values 0,1)

devcg = Specifies how many DevastatorCGs will be available on the level. (legal values 0-16)

devrl = Specifies how many DevastatorRLs will be available on the level. (legal values 0-16)

des = Specifies how many Desecrators will be available on the level. (legal values 0-8)


ex1. (in the console)

vote gamemode 0 ff 0 devcg 2 devrl 0

This command will initiate a vote to change the gamemode to 0 with friendly fire off (Devs. vs. Grunts), as well as having NO DevastatorRLs and 2 DevastatorCGs available on the level.

ex2. (in the console)

vote devcg 3 devrl 4 des 3

This command will initiate a vote to have 3 DevastatorCGs, 4 DevastatorRLs, and 3 Desecrators available on the level.

Once a vote is initiated by a player, every other player has 30 seconds to type "yes" or "no" in the console to acknowledge the vote. A vote must have 50% of all the total players to pass. After the 30 seconds another vote may be initiated.


yes = Agrees with the currently initiated vote.


no = Disagree with the current initiated vote.


Teamplay messagemode2 chat symbols - (For Annihilation & Elimination modes ONLY)

Within messagemode2 (say_team) chat phrases players can automatically send status information about themselves by included special symbols within the phrase. Here's a listing of the symbols:

%A = Your current Armor count.
%H = Your current Health count.
%W = Your current weapon.
%E = Your current equipment (Grunt, DevastatorCG, DevastatorRL, Desecrator Operator).
%L = Your Current location (the current closet item).
%N = Who you're currently targeting with id (you must toggle id on).

So an example would be to type in the console:

say_team "My status is %h/%a, I am near a(n) %N, as a %E"

Could be interpreted as:

say_team "My status is 100/25, I am near a(n) Mega Health, as a Desecrator Operator"



Devastators & Desecrators:

* What is a Devastator? 

A Devastator is a human controlled, slow moving, heavy assault vehicle with 2 very...big...guns. There are two types of Devastators so far: DevastatorCG and DevastatorRL. Details on both are as follows: 

Armor - Designed for assault/support, the thick hull of a Devastator is capable of sustaining 5-7 times the damage a normal quake player can. 

Dual Chainguns - (DevastatorCG) - The chainguns on the DevastatorCG were designed for anti-vehicular combat, meaning they'll put a world of hurt on non-vehicles (i.e. you!). They deal nearly 1.5 times as much damage per bullet than a regular chaingun, and have a limitless supply of ammo, so one can rack up the frags very quickly.

Dual Rocket Launchers - (DevastatorRL) - The missile racks on the DevastatorRL here originally intended for anti-aircraft firepower. Unfortunately, now they'll be pointed at you. Firing in volleys of two, the rockets travel at about twice the velocity of the handheld RL's projectiles. 

Amphibious - The Devastator also has a built in life support system, so a player can't drown while in it. 

Critcal Damage Indicator - When the Devastator has sustained a considerable amount of damage, a warning light will appear on the HUD (heads up display) and an alarm will sound for every hit sustained thereafter. 

- So how do I get into these things? 
Devastators will spawn at the start of each map at random location. (In Elimination mode, you will chose to be one in the equipment menu.) They will appear as a revolving Devastator torsos and will remain there for 60 seconds then spawn at another random location, unless it is picked up.

These things are WAY too powerful, no fair! Well OF COURSE they have drawbacks! READ!

Slow - Most importantly is their speed. The Devastators trudge along at roughly half the normal player's speed. So if those little quake runts find cover, you can kiss them goodbye for a while. 

Size - Armor stacked to that magnitude tends to make for a bigger target. A Devastator is nearly twice as thick and slightly taller than a normal player. In other words, there's not too many things to hide behind, besides walls.

Mass - Carrying all that armor and firepower obviously makes a Devastator extremely heavy. Consequently, with each step taken a loud and resounding footstep will be heard from afar. Also, the shear weight of a Devastator restricts jumping severely.

No Pickups - Once inside a Devastator, the player cannot collect any items. That's right, no health, no armor, no weapons, no powerups, NOTHING. So whatever damage is done will never be repaired. So if you're face to face with one, get a shot off while you can, it adds up!

Overheat - (DevastatorCG) The DevastatorCG's chainguns tend to heat up after several seconds of continous firing. Firing for too long results in an overheat where the weapon will automatically shut itself down while it cools, during which it will not fire. 

Slow firing rate - (DevastatorRL) While the DevastatorRL's missile rack fires extremely fast rockets, the rate at which it fires is significantly slower than the handheld RL. This will give some people the chance to escape between volleys. 

- Destroying a Devastator
Upon destruction, the player who delivered the killing blow to the Devastator will be awarded with 5 frags a grunt, 2 frags to a Desecrator activator, or 2 frags to a Devastator. The Devastator item will be dropped at the site of the destroyed Devastator. So if you want one, blow it up, and grab that Devastator! NOTE: In Elimination (gamemode 2), the Devastator item will NOT emerged from a destroyed Devastator.

Suiciding (self destructing) - Self inflicted deaths while in a Devastator (i.e. falling, getting crushed, typing "kill" in the console, etc.) will result in -5 frags to the user.


* What is a Desecrator? 

Basically a mini tank. It will follow its activator and target any enemy within a certain range of itself. 

After it targets an enemy, it will pause while it "charges up" its weapon. If at the end of the charge up the target is still in range and in the Desecrators line of sight...well, there won't be much left of him/her. The impact also explodes cause massive damage to the area around the target. A frag will be awarded to the activator if a grunt is killed by the blast, and 2 frags will be awarded for Devastators or Desecrators that are vaporized.

While the Desecrator is extremely powerful and well armored, like the Devastators, it has faults. Read on.

Mainly the fact that it is VERY dumb. It won't be able to figure its way around corners or other types of turns. The activator will have to literally "guide" its every movement to get it to follow closely. Also, Desecrators take a 3 costly seconds to reload after firing a shot. This gives a lot of time for grunts to scramble for cover. And finally the Desecrator cannot climb ladders, limiting its mobility on certain stages.

As a note to activators, you REALLY don't wanna be in the way of a shot when it fires. As a note to everyone else, you REALLY don't want to be standing in the shadow of a falling Desecrator.

When the Desecrator is destroyed, 5 frags are awarded to a grunt, or 2 frags Devastators or other Desecrator activators. Be warned, Desecrators take a BEATING.

What happens when the activator is killed? The Desecrator will collapse and become available to any user for pickup. And no, the activator cannot be a Devastator. So many times it's quicker and easier to kill the activator than the machine itself. NOTE: In Elimination (gamemode 2), the Desecrator will become available to any grunt on the same team.



FAQ:
----

Q: Is there a way out of the Devastator once I'm in it? 
A: Yes, die. 

Q: I can't kill these things, this sucks! 
A: Stop trying to fight them toe-to-toe and play the shoot and scoot game. Use your environment! Only rush them when you can SEE they've been damaged.

Q: The Desecrator is WAY too powerful!
A: Well, if you run right at it, of course you're gonna die. Again, use your environment! Remember it's only as strong as the guy who's using it. Play a peek-a-boo game with it, and it's as good as dead.

Q: I can't find any anything anywhere!
A: Make sure you're not running a single player mode game (see below), if in multiplayer either
   people have control of all the Devastators or Desecrators already, or wait 60 secs and look again. They might've been in the lava, they respawn every 60 seconds.

Q: I can't see the models, they all look like humans.
A: Fool, re-download the mod. www.planetquake.com/devastation.

Q: I can't run Devastation Quake2 in single player mode? 
A: No, Devastation Quake2 IS NOT a single player mod. Neither Devastators nor Desecrators will spawn, and there will be no   monsters. Run a multiplayer server if you want to run around alone.

Q: Sometimes the game crashes in software mode with no error.
A: The Devastator models cause an instability in Quake2 when running in SOFTWARE MODE. The fix is to buy a 3D card and run it in GL Mode. Granted you CAN still run it in software mode, but a crash is imminent. Some people have luck with it though.

Q: In modem play sometimes I "overflow". 
A: If you're running in software mode the problem might be related to the question above. If not your, or the server's connection sucks.

Q: How come this mod sucks?
A: Cuz you're a dumbass.

EOF