/=======================================================\
|       	     TFII X-Project v2.3		|
\=======================================================/

You have downloaded the 2.3 version of TFII X-Project.

/=========\
|  About  |
\=========/

TFII X-Project is a remake of a class-based mod TF1
(Team Fotress Software) for Quake2 (Id Software). THIS 
PRODUCT IS NOT SUPPORTED OR LICENSED BY Team Fortress 
Software OR Valve Software OR Id Software.

/============\
| Disclaimer |
\============/

Software under this agreement is under no kind of warranty. Software
under this agreement is provided as is, and isn't guaranteed in any
way by the authors. Use this software at your own risk.

/================\
|  Installation  |
\================/

Run the file you have downloaded from Internet and choose
as a path for Installation a folder in which your version of
Quake2 is installed. If you have any technical problems with
running the installation file contact Nico Mak Computing, Inc.
(http://www.winzip.com/).

/=========\
|  Notes  |
\=========/

TFII X-Project is installed in tf2 folder by default. Please, 
don't rename it or you may experience some problems while playing
in Internet or LAN, because of a difference in folder names.

-==================-

/======================\
|  What's new in 2.3?  |
\======================/

- Added offhand grapple hook in Lithium style.
- Bugs fixed in medic's and demoman's inventory.
- Bug fixed when game showed 0 ping of all clients.
- A lot of new models and sounds.
- Motd is now read from 'motd.txt' and can contain more than 1 line.
- Chase Camera by James Williams aka sATaN added.
- Feining spies can't be identified by enemies.
- Spy's backstab now ignores armor.
- Changed number of carried napalm grenades to 2.
- EMP grenades won't destroy friendly sentries if teamplay is set to 1 or 2.
- Hwguy's special command now switches between Assault Cannon and Super Shotgun.
- Medic's special command now switches between Bioweapon and Machinegun.
- Hwguy's mass value is now much higher.
- Hwguy is not affected by concussion grenade while firing.
- Fixed bug when changing weapon while disguised could change spy's skin.
- Fixed bug when detpack couldn't be set properly.
- 'sfeign' command for 'silent death' added.
- Each team can have max of 8 (in Internet ver) or 15 (in LAN ver) pipebombs at the same time. 
Current number of active pipebombs is shown on HUD of each team demoman.
- Reduced concussion time for medic.
- Many more unnamed bugfixes and tweaks.

/==============\
|  Map voting  |
\==============/

All players can vote for the next map on server. One player must
type "warp" and other players can vote for the next map which is in 
sv_maplist. They can type "vote yes" or "vote no". Voting lasts
for 30 seconds.

/========\
|  Menu  |
\========/

Menu style is similar to TF, it uses buttons from 1 to 0. If you think that bindings are
not correct and invalid menu items are selected type 'exec bindings.cfg' to restore original 
configuration. Commands have "impulse_x" style.

/===========\
|  Classes  |
\===========/

There are 9 classes in TFII X-Project. Here they are:

     Class Name:    		|     Abbreviation:	|
__________________________	|_________________	|
1. Scount            		|1. "scout"
2. Sniper            		|2. "sniper"
3. Soldier           		|3. "soldier"
4. Heavy Weapons Guy		|4. "hwguy"
5. Demolition Man		|5. "demoman"
6. Combat Medic			|6. "medic"
7. Pyro             		|7. "pyro"
8. Engineer          		|8. "engineer"
9. Spy              		|9. "spy"
   Random Class			|   "randompc"

As you can see the numbers of Heavy Weapons Guy, Demolition Man,
Combat Medic, Spy and Engineer ARE NOT equal to TF1 ones. So when 
you port your tf map and you have any class-specific doors or plats
please renumber them.
If you want to change your class during the game type the proper
abbreviation without "'s and after death you will respawn as a
class you selected previously.

/=======================\
|  Classes Description  |
\=======================/

/////////////////////////////////////////////////////////////////////////////////
Scout:
 The fastest class. He carries Axe, Machinegun, Shotgun, Flash and Concussion
grenades. He starts with 25 units of Jacket Armor. His maximum armor is 50.
His maximum speed is 500, though I'm not sure if limit of speed in Q2 is more 
300. Scout also carries a scanner which detects enemies and friends. You can 
set a radius of scanner by using these commands: "scan10", "scan30" or "scan100".
Commands: 
"scan10"
"scan30"
"scan100"

Scout can also detect spies if contacts them.

/////////////////////////////////////////////////////////////////////////////////
Sniper:
 His speed is medium. He has Axe, Machinegun, Sniper Rifle, Normal and Flash grenades.
His maximum armor is 50 of Jacket Armor. He can use his Sniper Rifle to aim enemies
from long distances using special command "autozoom". While sniper holds the attack
button a crosshair appears on the wall player looks at. Longer player aims, the more
damage he can cause. If sniper releases the attack button, his rifle will fire with
a bullet. If it hits someone head he will die, if it hits his chest bullet will cause
a normal damage, which is shown on the sreen. By getting shot in his legs player will
slow down. Sniper can also fire his rifle in auto mode. It fires faster and uses more
ammo, it's good for picking up fast targets.
Commands: 
"autozoom"
"auto"

/////////////////////////////////////////////////////////////////////////////////
Soldier:
 He looks and moves like a standart Q2 player. He begins with 100 units of Body 
Armor, Axe, Shotgun, Super Shotgun, Rocket Launcher, Normal and Nail grenades. Maximum limit of 
armor is 200. He can carry only 2 nail grenades at a time.

/////////////////////////////////////////////////////////////////////////////////
Heavy Weapons Guy:
 The slowest class. He carries Axe, Shotgun, Super Shotgun and Assult Cannon. His maxi-
mum armor is 300 of Body Armor. He also carries 4 Normal grenades and 1 Mirv grenade.
His Assault Cannon is one of the most powerful weapons in the game, but he can fire it
stand on ground and doesn't move. It takes 4 cells to power up Assault Cannon. Assault
Cannon's ammo is shells. The longer Hwguy fires the harded it is to fire this weapon,
because it becomes very unstable.

/////////////////////////////////////////////////////////////////////////////////
Demoman:
 Medium speed class. he caries Axe, Shotgun, Grenade Launcher and Pipebomb Launcher.
LImit of armor is 120 of Combat Armor.He also has 8 grenades, 4 Normal and 4 Mirv. 
Limit of pipebombs is 5. He can detonate them using 'detpipe x' command, where x is 
number of pipebombs he wants to detonate. If x is not specified all grenades are 
blown up. He also can use detpack, which is a bomb with configurable timer. Radius 
of explosive is very small but damage is very high. Here are the commands to set 
detpack: "+det5" "+det20" "+det50". Numbers after "+det" are numbers of seconds. If 
timer hits that value detpack will explode.

Commands:
"+det5"
"+det20"
"+det50"
"detpipe"

/////////////////////////////////////////////////////////////////////////////////
Combat Medic:
 Medium speed class. His limit of armor is 100 of Combat Armor. Medic carries 
BioWeapon, Shotgun, Super Shotgun, Chaingun and Bioweapon. Bioweapon is a 
unique weapon. It can infest enemies and heal teammates. Infested player will die 
and medic will get a frag for infesting. Infested player can also infest others by 
touching them. By healing teammates Medic can get frags for removing effects of 
concussion, gas and flash grenades, tranquilisator and for removing infection and fire.
Teammate who is being healed can get 250 health if Medic has enough medikits. Medic can 
pickup medikits by touching health boxes if his own health is at maximum. Combat Medic
also heals himself sometimes if he has medikits at his inventory.

/////////////////////////////////////////////////////////////////////////////////
Pyro:
 Medium speed class. He carries Axe, Shotgun, Incendiary Cannon and Flamethrower. Limit
of armor is 150 of Combat Armor. He has 5 grenades: 1 Normal and 4 Napalm. Napalm 
grenades explode throwing fire in random directions (very good for clearing areas).
His Incendiary Cannon can also clear areas exploding and throwing fire on the floor.
Direct hit may cause a very serious damage (weapon takes 3 rockets per shot). 
Flamethrower is a close-range weapon. It throws 2 big burning flames. Anyone hit 
by them takes damage and catches on fire (almost always). Very good 1-st line 
weapon (it takes 2 cells o fire). 

/////////////////////////////////////////////////////////////////////////////////
Engineer:
 This medium speed class carries Spanner, Super Shorgun, Railgun and Spanner, 2 Normal 
and 2 EMP (ElectoMagnetic Pulse) grenades. EMP grenades are very powerful grenades
that explode ammo (except bullets) in the range of it's own explosion. Railgun is
a high-speed (0.4 seconds delay) weapon that is not stopped by hitting players. It's
shot can only be stopped by wall. It's damage is 25 and it uses slugs. Engineer can
also build/detonate such structures as: Sentry and Dispencer (use "build" command).
Sentry guards position and can be upgraded from 1-st level to 3-rd. On the first 
level it uses Chaingun, on the 2-nd - Rocket Launcher and on the 3-d - Railgun. To 
do something with your sentry you must touch it or hit it by your spanner. Friendly
engineers can also repair/upgrade/etc. your sentry. Dispencer is an ammobox where 
you can store ammo and armor. It regenreates ammo and armor each 10 seconds. You can
put armor and ammo is dispencer by hitting it with your spanner. To withdraw some 
ammo or armor you must touch it. Friendly engineers can also put ammo/armor into 
your dispencer. Other players (including enemies) can only withdraw ammo/armor. 
Engineer can also make ammo: use discard to drop specific ammo. If you don't have 
enough ammo to drop you will create it if you have enough metal. Engineer can get 
metal by picking up cells ammo boxes.

Commands:
"build"

/////////////////////////////////////////////////////////////////////////////////
Spy:
 Spy is a medium speed class. He carries Knife, Super Shotgun, Machinegun and Tranquiliser Gun 
(default weapon). He has 2 Normal and 2 Gas grenades. Max limit of armor is 100 of Jacket Armor.
Tranquiliser Gun uses shells and anyone caught it's bullet slows his speed. Spy is a good 
offensive class. It can get into the well-defensed base using his disguise abilities. He can 
change his colors, skins or if server enables it he can become invisible (it takes 3 cells per 5
second to stay invisible) and pretend to be dead (feign death). There 2 types of feign death: 
silent and normal. For silent deaht type 'sfeign'. If nobody sees you, you will feign silently, 
otherwise you will disguise as usual. His Knife can cause more damage (x2) if spy hits an enemy 
in the front and if spy hits an enemy in the back (x6).

Commands:
"disguise" - disguise menu
"feign" - feign death
"sfeign" - silent feign death

/////////////////////////////////////////////////////////////////////////////////

/====================\
|  Commands summary  |
\====================/

General:
"special" - do 'special' thing for this class
"id" - 'id' player, dispencer, sentry you're looking at
"inv" - displays number of grenades of each type and your team number

Class Chaning:
"scout" - change class to scout
"sniper" - change class to sniper
"soldier" - change class to soldier
"hwguy" - change class to hwguy
"demoman" - change class to demoman
"medic" - change class to medic
"pyro" - change class to pyro
"engineer" - change class to engineer
"spy" - change class to spy
"randompc" - change class to random
"changeclass" - select class from menu

Grenades:
"primeone" - primes the grenade of 1-st type
"primetwo" - primes the grenade of 2-nd type
"throwgren" - throws the primed grenade

Grenade Bindings:
"+gren1" - primes the grenade of 1-st type
"-gren1" = "throwgren"
"+gren2" - primes the grenade of 2-nd type
"-gren2" = "throwgren"

Grapple Bindings:
"+hook" - hold this to fire grapple hook
"-hook" - stop firing grapple hook

Feign Death:
"feign", "sfeign" - quick feign death

Detpack:
"+det5" - setes detpack for 5 seconds
"+det20" - setes detpack for 20 seconds
"+det50" - setes detpack for 50 seconds

Reloading:
"reload" - reloads your current weapon

Scanner:
"scanf" - toggles scanning of friendly units (not used)
"scane" - toggles scanning of enemy units (not used)
"scan10" - scan for units within 250 radius
"scan30" - scan for units within 750 radius
"scan100" - scan for units within 2500 radius

Team Commands:
"showclasses" - prints you classes of your teammates
"query" - displays team equalisation factors
"saveme" - indicates that you need help
"discard" - drops ammo you choose (but not your current)

'Special' Equivalents:
"disgiuse" - going undercover (spy only)
"autozoom" - toggles between autozoom on/off (sniper only)
"az" = "autozoom"
"auto" - toggles between normal/auto sniper rifle (sniper only)
"build" - build/detonate engineer's structure (for real men only :))
"detpipe" - detonates all your pipebombs.

Voting:
"warp x" - start voting for warping map 'x' is it's in the maplist
"vote yes" - voting yes
"vote no" - voting no

Misc:
"showinfo" - prints your class info
"chasshelp" = "showinfo"
"ch" = "classhelp"
"maphelp" - prints you 'maphelp' string (if specified)
"flaginfo" - displays your flag status
"chasecam" - toggle on/off chase camera. Works only if server variable 'chase' is on.
"showloc" - displays your location + angles
"reset" - refreshes console (equivalent to pressing ENTER in console)
"exec_class" - each time you change your class "yourclass.cfg" is executed at respawn
"exec_map" - each time map changes you execute "mapdefalt.cfg" + "mapname.cfg" configs
"ec" = "exec_class"
"em" = "exec_map"

/============================\
|  Level Description System  |
\============================/

See example_cfg/bridge.ini for example.
Ini files must be stored in cfg/mapname.ini file for each map. Mapname is part of 
map's filename (ex: q2ctf1.bsp - mapname is q2ctf1).

/=================\
|  Server setup   |
\=================/

Here's the list of server variables:
"respawn_delay x" - where x is the number of seconds. Player can't respawn for x seconds 
                    after suicide.
"footsteps 0\1" - sound of footsteps is on/off
"shell_ejection 0\1" - weapons that use bullets and shells eject empty shells
"tflags x" - see server.cfg
"capturelimit x" - if captures of one team reach x game end in team's victory
"extratime x" if game ends in a tie match will continue for x minutes
"sv_votepercent x" - if percents of players votes for changing map > x map will change
"grapple x" - grapple on if value is higher than 0 and off otherwise
"zk_logonly x" - specifies if quake2 should only log players who use 'impulse' command
"dragontf x" - mode, when Demoman and Pyro have 4 Mirv or Napalm grenades
"quickweap x" - enables\disables quick weapon switching
"chase x" - to prevent cheating (looking behind the corner) server can disable chasecam

Next variables are used to limit number of specific classes at 1 time per team. If value
is < 0 then countless number of specific class is aviable.

"max_scouts"
"max_snipers"
"max_soldiers"
"max_hwguy"
"max_demomen"
"max_medics"
"max_pyro"
"max_engin"
"max_spies"

/=======\
| Motd  |
\=======/

Message Of The Day is now read from 'motd.txt' in 'tf2' folder. Write there everything 
you want.

-==================-

/===================\
|  Troubleshooting  |
\===================/

If you experience any problems that are NOT caused by your hardware please
visit 

http://www.planetquake.com/5thD/

and leave message at its message board at one of the topics dedicated to TF II X-Project

or mail 

vic@captured.com

/====================\
|  Staff (credits)   |
\====================/

  Alconaft - idea, design (danila@child.ru)
  Vic - coding, design, map specs, readme (vic@captured.com)
  Webrunner - models, gfx, sounds.
  Dromok - coding (linux version).

Additional credits:
	Eric Wojan - v2.2 and some v2.3 skins.
	DOX - some models
	James Williams - a.k.a:  sATaN - chasecam

Some of the code was influenced by TF 2.5 sources
(thank you guys for releasing it). Though code was 
originally written for RIP II (http://www.captured.com/rip2/). 
 
/================\
|  Thank you's   |
\================/

  ZIPA - support, unreleased map and good sence of humor :)
  Dimon and Archer - support 

  Everybody who helped with us, though he may not know that :)  

  We must also say 'thank you' for all you who downloaded our
  mod, tried to help us and gave us advice. THANK YOU!