=======
=NeoTF=
=======
Version 1.1 rev 5
A server-side mod for TFC.

Contents
========

1 - Installing NeoTF on a server
 1.1 - Installing the DLL
 1.2 - Getting NeoTF to work with other mods such as Admin-Mod
 1.3 - Installing new glyphs on the server
 1.4 - Enabling features individually
 1.5 - Removing NeoTF from a server
2 - Features of NeoTF
 2.1 - Glyphs
 2.2 - Scout radar
 2.3 - Chat spying
 2.4 - Flash grenades
 2.5 - Sentry gun cameras
3 - Bugs
4 - Credits
5 - Contact information


1 - Installing NeoTF on a server
================================

1.1 - Installing the DLL
------------------------

Unzip the zip file into the relevent directories. Files should be in the follwing places:

	tfc\ntf_help.txt
	tfc\ntf_config.txt
	tfc\ntf_glyphs.txt
	tfc\dlls\ntf.dll
	tfc\<mapname>.nli
	tfc\sprites\glyphs\t_<glyphname>.spr
	tfc\sprites\glyphs\g_<glyphname>.spr

To get Half-Life to load the NeoTF .dll file instead on the default tfc.dll, you need to edit tfc\liblist.gam - find the line that says:
gamedll "dlls\tfc.dll"
and replace with
gamedll "dlls\ntf.dll"

If you are installing NeoTF in addition to anther TFC mod (such as admin-mod) follow the instructions in the following section about editing liblist.gam

1.2 - Getting NeoTF to work with other mods such as admin-mod
-------------------------------------------------------------

NeoTF should work with admin-mod and some other mods of TFC but this is untested. You need to edit tfc\liblist.gam and ntf_config.txt as follows:
tfc\liblist.gam - find the line:
gamedll "dlls\moddll.dll" or whatever dll you are currently using. Make a note of the name and replace with
gamedll "dlls\ntf.dll"
tfc\ntf_config.gam - change "tfc.dll" to the filename of the DLL you wish to load in addition to NeoTF. You don't need to include the path, the DLL must be in the tfc\dlls\ directory.
If this method doesn't work for you, and the other mod you're using is a MetaMod plugin, try the following:
Set up admin mod first. Then add the files for ntf without making any changes to liblist.gam. Now create a file named metagame.ini with dlls/ntf.dll
Thanks to Ramirez for that solution!


1.3 - Installing new glyphs on the server
-----------------------------------------

The list of glyphs and the command to use each one is in tfc\ntf_glyphs.txt
To install a new glyph, place the .spr file in the tfc\sprites\glyphs\ directory and add an appropriate line to tfc\ntf_glyphs.txt

Any new glyphs must be 32x32 with alpha transparency. They can be animated. Any client will automatically download the sprite files from the server upon connecting. Be aware that Half-Life has a set precache limit that is shared between sprites and models, so using a very large number of glyphs may cause unexpected crashes on map load -- if this happens, remove some from the list.

1.4 - Enabling features individually
------------------------------------

Here's a complete list of cvars that control which features are enabled:

ntf_feature_spychat
ntf_feature_radar
ntf_feature_flashgren
ntf_feature_noplayerscores
ntf_feature_sgcamera
ntf_feature_laserrocket
ntf_feature_antimissile
ntf_feature_devmode
ntf_feature_multigun
ntf_feature_teslacoil
ntf_feature_location
ntf_feature_meddisp
ntf_feature_airstrike
ntf_feature_grenlaunch
ntf_feature_rocklaunch
ntf_feature_custommodels *
ntf_feature_glyphs *
ntf_flashgren_hurt_team

Setting the above cvars to a value of 0 disables that feature, and setting them to 1 enables it. devmode should always be 0 on public servers -- its only real use is for creating location information files. If glyphs/custom models are disabled, clients won't have to download them on connect.

* Changes to this setting will only take effect at the start of the next map, due to the precaching system

1.5 - Removing NeoTF from a server
----------------------------------

To remove NeoTF from a server, edit tfc\liblist.gam and replace the line:
gamedll "dlls\ntf.dll"
with:
gamedll "dlls\tfc.dll"

If you are also using another server mod such as admin mod, use that DLL filename instead.


2 - Features of NeoTF
=====================

2.1 - Glyphs
------------

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.

2.2 - Scout radar
-----------------

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.

2.3 - Chat spying
-----------------

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.

2.4 - Flash grenades
--------------------

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.

2.5 - Sentry gun cameras
------------------------

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.

2.6 - Snipers' laser guided rockets
-----------------------------------

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.

2.7 - Anti-missile missile launchers for snipers
------------------------------------------------

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

2.8 - Engineers' multiguns
--------------------------

Build one of these as an engy with either the "_special2" command or the "buildmultigun" command. You can detonate it with the "detmultigun" 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). When a teammate touches it, it's upgraded to a different type of gun depending on which class touched it. 
	
	Multigun upgrades:
	scout/spy	- tesla coil
	demoman/hwguy	- grenade launcher
	soldier/pyro	- rocket launcher
	
2.9 - Medic dispenser upgrades
------------------------------

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

2.10 - Airstrikes
-----------------

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.

2.11 - 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!;"

2.12 - No player scores
-----------------------

If this feature is enabled, all player's frag counts will be permanently at zero, though team scores are still visible. This is to help encourage teamplay and discourage deathmatching in TFC.

3 - Bugs
========

Please report any bugs with an accurate description to: neotfmod@hotmail.com

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

NeoTF was created by BillDoor. Custom models by Seppukko. 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.

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

You can contact me at neotfmod@hotmail.com
the NeoTF website is currently at http://www.geocities.com/neotfmod