############################
### Warcraft3 AMX Plugin ###
############################

####
###
### Installation
### * Setup
### * Description of the plugin
###
####

Installation of WC3 MOD :
-------------------------
For installation intstructions please read the installer.txt

There is also a forum for the plugin, if you have further questions about the plugin.
http://wc3mods.net/forums/index.php?c=6&sid=9c15510adfb4f11e1d91e3e58ae6521b

Description: 
------------
When you enter the game you get to choose a race (undead, human, orc or night elf), each race has 3
different skills and an ultimate skill. You start out without any special skills, but as you gain
frags you gain Experience. With each new level of experience you get to select a new skill or upgrade
a skill you already have (the menu will popup at the start of the next round automatically, or you can
do it manually by typing "selectskill" in the console or binding a key to it). Once you get to level 6
you can choose the ultimate skill, to use these your going to need to bind a key to the command "ultimate".
type "war3help" in the game for more details.

This version of WC3 also includes an "expanded_races" mode that enabled 4 new races: blood elf, troll, dwarf, lich
Read installer.txt for information on how to configure WC3.

Server Settings:
----------------
There are two modes this plugin can be run in: Short term XP and Long term XP.

Short Term XP

This is the default, in this mode XP is gained quite fast as is designed so that you should
be able to reach a high level within 30/40 minutes of playing. Your XP, race and skill information
are reset to 0 on each now map. If you just want to have a quick game then this is the best option.

Long Term XP

In this mode you gain XP slower than the regular mode but your XP is kept from map to map. Even if
you disconnect and come back later your XP is saved to a text file and you retreive it as soon as you
join the server. XP is saved using AMXX's vault system. The plugin will first try to save XP for each
person based on SteamID if that fails it will use the IP address (this is usefull for lans). Please don't
mess around with this file as it will most likely cause the plugin not to load properly.

To activate this mode you will need to reconfigure the plugin. See installer.txt

Please note that reconfiguring will not take effect until the next map change. Also there is another server
variable that will help you adjust the speed at which you gain levels. "mp_xpmultiplier 1.0", the
default is 1.0, by changing this to say 0.5 it would allow you to gain a level at half the normal
xp required for that level. "mp_xpmultiplier 2.0" would require you to gain twice as much XP to reach
the same level. This is usefull for say lan parties where you want to play over the whole week-end,
you could adjust it take make sure you would reach level 10 by the end of the week-end but not before.

XP is saved for each race independently, this means that you can play as one race and then switch to
another race starting from 0 xp. But then if you switch back to your original race you will regain the
XP you had.

XP does not stay forever though, once per day the vault.ini is updated removing any inactive entries.
If you don't connect to the server for a certain number of days you will be removed. These are controlled
by the plugin and default to 14 days of inactivity. See installer.txt for information on reconfiguring.

This is to prevent the vault.ini file from getting too big, while allowing high level players to
keep their settings for longer.

Also if you want to prevent certain maps from being played with longterm xp, create a file named
war3maps.ini and place it in your cstrike root directory and put the name of the maps you want
on a seperate line, for example:

aim_map
awp_map
aim_ak-colt


Console Commands
----------------
Client:
"war3menu" - Show WarCraft3 XP Player menu
"selectskill" - Allows you to select skills before the start of the next round
"changerace" - Allows you to change race during the game if "mp_allowchangerace" is "1"
"playerskills" - Shows you what skills other players have chosen
"skillsinfo" - Shows you what each skill does for the race you have selected
"itemsinfo" - Shows you a list of items and what they do
"dropitem" - You can drop ypur current item.
"war3help" - gives you a list of the console commands
"war3vote" - vote to switch the plugin on and off
"say /changerace" - same as "changerace"
"say /selectskill" - same as "selectskill"
"say /playerskills" - same as "playerskills"
"say /skillsinfo" - same as "skillinfo"
"say /itemsinfo" - same as "itemsinfo"
"say /level" - displays level, race and skill information
"say /war3vote" - vote to switch the plugin on or off
"say /war3help" - displays info about the plugin

Server:
"sv_warcraft3" - Enable/Disable the plugin (default 1, enabled)
"sv_allowwar3vote" - Enabled/Disable voting (default 1, enabled)
"mp_allowchangerace" - Allow people to change race during the game (default 0, disabled)
"mp_grenadeprotection" - prevents buying more than 1 HE gren per round (default 1, enabled)
"mp_weaponxpmodifier" - gives additional XP for using certain weaker weapons (default 1, enabled)
"amx_vote_delay" - set delay between which votes can be started (default 60)
"amx_vote_time" - set the amount of time you have to vote (default 10)
"amx_votewar3_ratio" - set the minimum ratio of votes required (default 0.40)
"amx_vote_answers" - display player votes (default 1, enabled)
"mp_xpmultiplier" - set the level required to gain a level as a multiple (default 1.0)


Cvars 
-----
Server information cvars (useful for programs like "all seeing eye" or "gamespy")
 - "Warcraft_3_XP" 
 * "mp_savexp"
 - "mp_xpmultiplier"
 - "sv_warcraft3"

normal cvars 
 * "mp_alloworcnade"
 - "mp_allowchangerace"
 * "mp_shopzone"
 - "mp_weaponxpmodifier"
 - "sv_allowwar3vote"
 - "amx_vote_delay"
 - "amx_vote_time"
 - "amx_vote_answers"
 * "sv_mysqltablename"
 - "amx_votewar3_ratio"
 - "sv_wc3icons"

cvars marked with * may not be available, depending on which pre compilation directives are used.


Skill Descriptions
------------------
UNDEAD

Vampiric Aura: Gives you (15%, 30% or 45%) of the damage you do in attack back as health,
               (i.e. if you shoot someone and do 100 hp damage you will get back either
               (15, 30 or 45 hp) back depending on the skill level)
Unholy Aura: Gives you a speed boost, also all weapons make you go at the same speed
             (running with knife will not make you move faster than running with AWP) 
Levitation: Allows you to jump higher, basically reduces your gravity to reach high places
            you wouldn't normally be able to reach. 
Ultimate, Suicide Bomber: player will explode when he dies, killing enemies around him

HUMAN

Invisibility: You become partially invisible
Devotion Aura: Gives you more heatlh at the start of each round (130, 160, 200)
Bash: When you shoot someone you have a (15%, 30% or 45%) chance of rendering them immobile
      for 1 second. (their maxspeed is set to 0 for a second) 
Ultimate, Teleport: Ability to teleport to team mates, or where you are currently aiming at (depoending on server admin) (20 second cooldown)

ORC

Critical Strike: Gives you a 15% chance of doing (2, 3, or 4) times normal damage on each shot
Critical Grenade: Will ALWAYS do (2, 4 or 6) times normal damage when you hit someone with
                  a grenade.
Equipment Reincarnation (Ankh): Gives you a (33%, 67% or 100%) chance in respawning with the
                                equipment you had before you died last round. 
Ultimate, Chain Lightning: Ability to cast lightning jumping from player to player harming them,
                           damage decreases by 2/3 each jump.

NIGHT ELF

Evasion: Gives you a (10%, 20% or 30%) chance of evading a shot, i.e. you will not lose any
         health over it but it will still seem as though you where hit. 
Thorns Aura: Does (10%, 20% or 30%) mirror damage to the person who shot you. 
Trueshot Aura: Does (15%, 30% or 45%) extra damage on each of your bullets. 
Ultimate, Entangle Roots: Immobilises enemy for 10 seconds.

EXPANDED RACES:
BLOOD ELF

Crimson Armor: Gives you full armor plus (25, 50 or 100) at the start of the round.
Mana Shield: Any damage you take from enemies, except that which would kill you, is reduced by (15%, 30%, 45%)
Bloodlust: Each shot adds (3, 6 or 9) damage to the enemy. Movement speed of those who attack you is reduced temporarily.
Ultimate, Shadowstrike: Emits a powerful damaging force at an enemy in your sights

TROLL

Silent Run: Gives you a chance at being silent with no footsteps. (33%, 66% or 100%)
Regeneration: You regenerate health if you are below the limit. (50, 75 or 100 hp)
Berserk: Adds 15 damage to each of your shots if your health is below the limit. (20, 40 or 60 hp)
Ultimate, Healing Wand: Allies near you, and yourself, are regenerated for 50 health. You gain an extra 5.

DWARF

Grenade Sack: Gives you grenades (1, 2 or 3) each round.
Mithril Armor: Any damage you take from enemies will be reduced (3, 6, or 10), unless the damage is less than that amount plus 5.
Extended Ammunition: Adds 3, 6 or 10) bullets to each of your weapon clips.
Ultimate, Avatar: Gives you godmode for 2 seconds. Necklace of Immunity will allow you to be damaged.

LICH

Ice Shards: You have a chance (10%, 15%, or 20%) of dealing 100% mirror damage.
Terror: You have a chance (10%, 20%, or 30%) of darkening your enemies screen like a reverse-flashbang when you shoot them.
Frost Armor: You have a chance (15%, 30%, or 45%) of adding the amount of damage you dealt to your armor.
Ultimate, Frost Nova: All enemies within range are drasticly slowed for 5 seconds.


GLOW COLORS:
Red: Extra damage done to the player who glows (Critical Strike/Grenade or Thorns/Trueshot Aura)

White: This is when you get bashed, player glowing can't move for 1 second

Green: You will glow green if you have vampiric aura and do dammage to another player.
       You will also glow green at the start of the round if you have Weapon Reincarnation.
       You will also see a green glow from Troll Regen or Healing Wand.

Blue: You glow blue when you evade a shot with the Night Elf Evade ability.

Purple: You have been hit by the Ice Shards skill

Aquaish (:P): Lich Frost Armor skill has activated.

Orange: You have been hit by extra damage from the Troll Berserk skill


Shop Items
----------

The shop works in the same way as buying weapons, except you can buy anywhere. You can hold only
1 item at a time, with the exception of the tome of experience (you can buy as many as these as
you want without losing your current item). If you buy an item while already holding an
item your previous item will be lost.
In order to buy items you must bind a key to "shopmenu" for example (bind i shopmenu)

Ankh of Reincarnation: If you die you will retreive your equipment the following round

Boots of Speed: Allows you to run faster

Claws of Attack +6: An additional 6 hp will be removed from the enemy on every hit

Cloak of Shadows: Makes you partially invisible, invisibility is increased when holding the knife

Mask of Death: You will receive health for every hit on the enemy

Necklace of Immunity: You will be imune enemy ultimates

Orb of Frost: Slows your enemy down when you hit him

Periapt of Health: Receive extra health

Tome of Experience: Automatically gain experience, the item is used on purchase. Will not work if XPLOIT protection is active.
