=======
=NeoTF=
=======
Version 1.3
A server-side mod for TFC.

Contents:

1 - Features of NeoTF
	1.0 - Binding Keys to Features
	1.1 - Glyphs
	1.2 - Radar
	1.3 - Chat spying
	1.4 - Flash grenades
	1.5 - Sentry gun cameras
	1.6 - Anti-missile missile launchers
	1.7 - Laser guided rockets
	1.8 - Multi Guns
	1.9 - Medic anti-grenade pods
	1.10 - Medic dispenser upgrades
	1.11 - Airstrikes
	1.12 - Location information
	1.13 - Landmines and Sensormines
	1.14 - Remote-controlled rockets
	1.15 - The Llama Cage
	1.16 - The Jetpack
2 - Server CVARS
3 - Bugs
4 - Credits
5 - Contact information


Features of NeoTF
=====================

1.0 - Binding Keys to Features
------------------------------

Most NeoTF features are activated by special commands.  The most common
special command is "_special2".  This command has a different effect for
each class.  See below for details.

If you want to use a key for the special commands, instead of having to
type it in the console each time, you'll need to bind it to a key.

Binding is simple.  To bind "_special2" to the key "X", just type this
in your console:

bind x _special2

Now everytime you hit the "X" key, the _special2 feature will be activated.
This will work for all other commands as well (for example, if you want
to bind "Y" to "detspecial, use "bind y detspecial").

All the commands you can use in NeoTF are described below.


1.1 - Glyphs
------------

Special Commands: "glyph <name>"
                  "glyph_team <name>"

Allowed Classes: all

Description:

Glyphs are a new iconic communication system that work in a similar way to the
"saveme" command that TFC has. When you use a glyph the icon appears above 
your head briefly for everyone (or only teammates) to see. Each server may 
have their own set of glyph icons. To see the glyphs available on a server use 
the "glyph_list" command from the console. To make the glyph appear above your 
head, use "glyph <name>" or "glyph_team <name>" in console, where <name> is 
the name of the glyph, as shown by "glyph_list". Note also that you can 
replace the word "glyph" with "icon" in these commands. NeoTF comes with the 
following glyphs:

Team communication glyphs:
attention
stop
go
dropflag
droppack
follow
heal
enemy
sentry

Insult glyphs:
ownzed
whore

Servers can add their own glyphs in the form of .spr sprite files, and clients 
will automatically download any that they don't have.

1.2 - Radar
-----------

Special Commands: "radar"
                  "_special"

Allowed Classes: Scout

Description:

The scout radar points out the directions of any nearby players, sentry guns 
or dispensers. The console command to use this is "radar" or "_special" when 
you are playing as a scout. The intensity of the beams drawn is affected 
slightly by the distance of the associated object. The scout using the radar 
emits an audible "ping" when he activates it.

1.3 - Chat spying
-----------------

Special Commands: none, activated server-side

Allowed Classes: Spy

Description:

If this feature is enabled, spies can overhear enemy teamchat. The message 
will be garbled somewhat, and the extent of the corruption will depend on the 
distance of the spy from the person that typed the message.

1.4 - Flash grenades
--------------------

Special Commands: none, use secondary grenade key

Allowed Classes: Sniper

Snipers now have a second grenade type, a flash grenade. Use it as you would 
any other grenade, ie. with +gren2, primetwo, or throwgren. It will partially 
blind any opponents in the immediate area for a few seconds. Servers can 
choose whether the flash affects teammates or only enemies with the cvar: 
ntf_flashgren_hurt_team - the default is not to hurt teammates.

1.5 - Sentry gun cameras
------------------------

Special Commands: "+sgcam", "sgcam_switch"

Allowed Classes: Engineer

Engineers have the ability to use their (and teammates') sentry guns as remote 
cameras. This involes two commands: +sgcam and sgcam_switch. Bind a key to 
"+sgcam" and hold it down to view through a teammates' (or your) sg. Use 
"sgcam_switch" to cycle through sgs that you can view through. Release the 
key bound to "+sgcam" to return to normal view.

1.6 - Anti-missile missile launchers
------------------------------------

Special Commands: "_special2", "buildspecial", "buildamlauncher",
                  "detspecial", "detamlauncher"

Allowed Classes: Sniper

Build one of these with the "_special2" console command (you can detonate 
it with the "detamlauncher" or "detspecial" commands). It will automatically 
shoot down any RPG, IC, and remote rockets in the immediate area. It also acts 
as a launching platform for laser guided rockets (see below).

If you've already built an AM launcher, the "_special2" command will activate
a laser-guided rocket.  See next section for details on these.


1.7 - Laser guided rockets
--------------------------

Special Commands: "_special2", "laserrocket"

Allowed Classes: Sniper

Launch one of these when you have your rifle charged, and there is a nearby 
friendly soldier, demoman or anti-missile launcher. Use the "_special2" or 
"laserrocket" command to launch.  Control the flight of the rocket by
aiming your dot.


1.8 - Multi Guns
----------------

Special Commands: "_special2", "buildspecial", "detspecial"

Allowed Classes: Engineer (build)
                 Scout    (upgrade)
                 Spy      (upgrade)
                 Demoman  (upgrade)
                 HWGuy    (upgrade)
                 Soldier  (upgrade)
                 Pyro     (upgrade)
                 Sniper   (upgrade)
                 Medic    (upgrade)

Build one of these as an engy with either the "_special2" command or the 
"buildspecial" command. 

You can detonate it with the "detspecial" command. 

When it is first built, the multigun will have a flickering form and be 
inert (except that it can still take damage and die).  

A teammate must TOUCH the inert multigun to upgrade it.  Different classes
produce different types of multiguns:
	
	Class         Upgrade            Description
	------------------------------------------------------------------------
	Scout         Tesla Coil         Blasts enemy with electric discharge
	Spy           Tesla Coil         Blasts enemy with electric discharge
	Demoman       Grenade Launcher   Fires demoman gl_grenades at enemy
	HWGuy         Grenade Launcher   Fires demoman gl_grenades at enemy
	Soldier       Rocket Launcher    Fires rockets at enemy
	Pyro          Flamegun           Fires exploding projectiles at enemy
	Sniper        Laser rock launch  Fires guided rockets at enemy
	Medic         Crowbar Shooter    Fires exploding crowbars at enemy

Once a multigun has been upgraded, it stays that way until destroyed.  If
you want to change the type of gun you have, you must detonate it and build
a new one.

NOTE: Multiguns WILL take damage from your own team.  Don't hit it with your
      wrench, this causes damage!


1.9 - Medic anti-grenade pods
-----------------------------

Special Commands: "_special2", "buildspecial", "detspecial"

Allowed Classes: Medic

A medic using the "_special2" or "buildspecial" command will build an
anti-grenade pod.  This pod will perform the following functions:

- Destroy nearby enemy type-2 grenades (e.g. nailgrenade)
- Destroy RPG and IC rockets (server must enable "ntf_ag_destroys_missile")
- Destroy detpacks (server must enable "ntf_ag_destroys_misc")
- Heals nearby teammates

1.10 - Medic dispenser upgrades
------------------------------

Special Commands: none

Allowed Classes: Medic

Touch any dispenser as a medic to upgrade it to a health-giving dispenser 
that recharges 5 health/second to those around it.

1.11 - Airstrikes
-----------------

Special Commands: "_special2", "airstrike"

Allowed Classes: Scout, Spy

Use the "_special2" or "airstrike" command as a scout or spy while looking 
at the sky to call an airstrike on your current position from the area of 
sky you were looking at. Airstrike are limited for each team based on time.

1.12 - Location information
---------------------------

In some popular maps, when using the "say" or "say_team" commands, you can 
relay your current position by including %l in the chat text. Use %p to 
give the position you're looking at, eg. "say_team Incoming enemy from %p!;"

1.13 - Landmines and Sensormines
--------------------------------

Special Commands: "_special2", "buildspecial"
                  "buildspecial2", "senmine"
                  "detspecial"

Allowed Classes: Demoman

Use the "_special2" or "buildspecial" command to build a landmine.  Use
the "detspecial" command to blow it up, causing significant damage.

Sensormines are built with "buildspecial2" or "senmine".  They work just
like landmines, but will let you know when an enemy is nearby.

Note that neither of these are *not* proximity mines - they must be 
detonated by hand!

1.14 - Remote-controlled rockets
--------------------------------

Special Commands: "_special2"

Allowed Classes: Soldier

When a soldier executes "_special2", they will launch a remote-controlled 
rocket.  The soldier's view will change to the nose of the rocket.  The
rocket is controlled using the mouse.  When it hits something, it will 
explode, causing significant damage.

The soldiers are allowed only one remote rocket per life.

1.15 - The Llama Cage
---------------------

Special Commands: "specialllamacage", "specialllamacageN", "detspecialcage"

Allowed Classes: All (must have authorization)

Players with proper authorization on the server can build the Llama Cage.
The Llama must then be teleported into the Cage.

The N on the build command determines how big the Cage is.  Note that most
maps are too small to hold the larger Cages =)

1.16 - Jetpack
---------------------

Special Commands: "_special2", "buildspecial"

Allowed Classes: Pyro

When a Pyro executes "_special2", they will ignite their Jetpack, which
will give them a short boost.  The jetpack can be used to launch the
pyro a short distance in the air, or quickly along the ground.

The jetpack consumes a default of 10 armor per use.



2 - Server CVARS
================

There are many cvars that affect the behaviour of NeoTF.  

Note these can only be controlled by the server administrator or through
rcon.

Here's a description of each:

Boolean =         
Integer = a positive integer

CVAR                         Allowed Values       Default
-------------------------------------------------------------------------
ntf_feature_noplayerscores   Boolean                0
If this is enabled, all player frag counts will be permanently at zero,
though team scores are still visible.  This is to help encourage teamplay
and discourage deathmatching in TFC.

ntf_feature_glyphs           Boolean                1
Enables/disables the "glyph" feature

ntf_feature_spychat          Boolean                1
Enables/disables the "spy chat" feature

ntf_feature_radar            Boolean                1
Enables/disables the "scout radar" feature

ntf_feature_flashgren        Boolean                0
Enables/disables the sniper's flash grenades

ntf_feature_sgcamera         Boolean                1
Enables/disables the engineer's remote SG camera ability

ntf_feature_laserrocket      Boolean                1
Enables/disables the sniper's laser rocket ability

ntf_feature_aquaspy          Boolean                1
If enabled, spies will not drown

ntf_feature_antimissile      Boolean                1
Enables/disables the ability of snipers to build antimissile pods

ntf_feature_devmode          Boolean                0
Special cvar for NeoTF development

ntf_feature_multigun         Boolean                1
Enables/disables the ability of engineers to build multiguns

ntf_feature_flamegun         Boolean                1
Enables/disables the ability of pyros to upgrade multiguns

ntf_feature_teslacoil        Boolean                1
Enables/disables the ability of spies and scouts to upgrade multiguns

ntf_feature_lrlaunch         Boolean                1
Enables/disables the ability of snipers to upgrade multiguns

ntf_feature_grenlaunch       Boolean                1
Enables/disables the ability of demomen and hwguys to upgrade multiguns

ntf_feature_rocklaunch       Boolean                1
Enables/disables the ability of soldiers to upgrade multiguns

ntf_feature_crowbarmg        Boolean                1
Enables/disables the ability of medics to upgrade multiguns

ntf_feature_meddisp          Boolean                1
Enables/disables the ability of medics to upgrade dispensers

ntf_feature_airstrike        Boolean                1
Enables/disables the ability of spies and scouts to call airstrikes

ntf_feature_airstrike_interval Integer            60
Amount of time in seconds before a team can call another airstrike

ntf_feature_landmine         Boolean                1
Enables/disables the ability of demomen to build landmines

ntf_feature_antigren         Boolean                1
Enables/disables the ability of medics to build anti-grenade pods

ntf_feature_custommodels     Boolean                1
Enables custom models 

ntf_feature_mgspyignore      Boolean                1
If enabled, MGs will ignore disguised spies.  
If disabled, MGs will shoot disguised spies.

ntf_max_remotes              Integer                1
Number of remote-controlled rockets a soldier is allowed per life.

ntf_max_multiguns            Integer                1
Number of multiguns an engineer is allowed to build.

ntf_max_antigren             Integer                1
Number of anti-grenade pods a medic is allowed to build.

ntf_max_antimissile          Integer                2
Number of anti-missile launchers a sniper is allowed to build.

ntf_max_landmines            Integer                2
Number of land mines a demoman is allowed to build.

ntf_max_sensormines          Integer                2
Number of sensor mines a demoman is allowed to build.

ntf_mg_armor                 Integer                50
The amount of armor required to build a multigun.

ntf_landmine_armor           Integer                25
The amount of armor required to build a landmine.

ntf_antigren_armor           Integer                100
The amount of armor required to build an antigrenade pod.

ntf_antimissile_armor        Integer                25
The amount of armor required to build an antimissile launcher.

ntf_landmine_armor           Integer                25
The amount of armor required to build a landmine.

ntf_sensormine_armor           Integer                25
The amount of armor required to build a sensormine.

ntf_cage_armor               Integer                10
The amount of armor required to build the Llama Cage.

ntf_jetpack_armor            Integer                10
The amount of armor required to use the Pyro's jetpack.

ntf_flashgren_ammo           Integer                2
The number of flash grenades a sniper gets (per life).

ntf_ag_destroys_ng           Boolean                0
If enabled, antigren pods will destroy normal grenades.

ntf_ag_destroys_missile      Boolean                1
If enabled, antigren pods will destroy missiles (rockets, ic rockets, etc).

ntf_ag_destroys_misc         Boolean                1
If enabled, antigren pods will destroy other objects: detpack, multiguns

ntf_auth_default             Integer (bitmask)      0
Default authorization level

ntf_airstrike_interval       Integer                60
Amount of seconds allowed between airstrikes for entire team

ntf_old_remotes              Boolean                0
0 = Soldier gets apache remote
1 = Soldier gets guided missile remote

ntf_apache_ammo              Integer                6
The amount of ammo the apache remote gets.  
One ammo used per rocket, two ammo used per bomb.


3 - Bugs
========

Please report any bugs with an accurate description to the Forums at
http://www.neo-tf.com


4 - Credits
===========

Current NeoTF development team:
Crrrazzzy
Hitokiri Battousai
SpannerSpammer
Maelstrom

NeoTF was created by BillDoor. Custom models by Seppukko and Engineer. 
Thanks to Professional Victim, Avatar-X, Invictus -TPF- and all the regulars to 
the SillyZone TFC server.

Parts of the code are taken from botman's HPB Bot source, without which none of this would be possible.

Thanks to FoxBot team for the MG-spy-detection code.



5 - Contact information
=======================

The NeoTF website is currently at http://www.neo-tf.com

