TerraStats Counter-Strike Source Plugin

File Release Notes and Changelog

Release Name: terrastats_plugin_bin_win32_v0.6.0

Notes:
=== TerraStats ==
 Copyright 2004, 2005 by HalfLifeTwoDev

SourceForge Project (files bug reports, feature requests):
http://www.sourceforge.net/projects/terrastats/

Documentation:
http://www.hl2-dev.com/wiki/tiki-index.php?page=TerraStats

Website & Discussion Board:
http://terrastats.hl2-dev.com/


INSTALLATION
=Obtaining the Plugin=
Download the latest stable binary release for your plugin from the
SourceForge project. Currently, binary releases exist only for
the Windows. Linux users must compile from the SourceCode?
provided on the project page. 

=Compiling the Source Code=
If building the binaries from source-code, for Windows, the recommended
compiler (used in development) is Microsoft Visual C++ 2003. For
Linux, the latest stable GCC is recommended along with a
up-to-date GlibC library.

=Installing the Binary Release=
For those with the binary release, extract the package to your server's
cstrike directory.

=Installing the Buillt SourceCode=
Once compiled, copy the DLL or SO (depending on
operating system) to the cstrike/bin directory.

Create the cstrike/TerraStats directory. This directory will hold the
PlayerStats database.

Create the cstrike/cfg/TerraStats directory. This directory will contain
TerraStats configuration files. 

If there isn't one already, create cstrike/Addons.

Inside addons, create a plain-text file named
'serverplugin_terrastats.vdf''. The file's contents should read:

"Plugin"
{
        "file"  "../cstrike/bin/serverplugin_terrastats"
}



Good job! Almost there...

Copy all of the .cfg files from the source-code release into the
cfg/TerraStats directory.

Done! Smoke a cigar ... Bill Clinton style if you can.


CONFIGURATION
TerraStats is developed to work properly out-of-the-box, so to speak.
Further configuration is not mandatory for proper execution. 

All configuration files are located in cstrike/TerraStats and have a
.cfg extension.

=Rating Schemes=
The following files all follow the same format:

    * localhub_rating_scheme.cfg
    * globalhub_rating_scheme.cfg
    * custom1hub_rating_scheme.cfg
    * custom2hub_rating_scheme.cfg
    * custom3hub_rating_scheme.cfg 


The format is strict, so follow it closely. Comments are created by
using # as the first character of a line. Each valid line follows the
format:
variable=value

Anything on either side of the = is considered either variable name or
value.

* name
This is only relevant for the custom RatingSchemes?. Otherwise, it is
ignored.

* kokoNormalize
This is a boolean value which excepts either true to enable
KokoNormalization or false to disable it.

* Deduction Points
afkKill, hostageKilled, newbieKill, and death are all values that deduct
from a player's TerraStatsRating. They are floating point values that
deduct in the following manner: 
rating = rating - (totalAfkKills * scheme.afkKill)

* Positive Points
The rest of the variables in each scheme of floating point values that
increase the player's rating per each total act. 

=terrastats.cfg=
This is the main configuration file that dictates the general behavior
of the plugin. 

ts_debug <0 | 1>
Disables (default) or enables TerraStats debug mode. Probably not very
useful unless your name is Kylratix. 

ts_topdawg_announce <0 | 1>
Disables or enables (default) announcement of when a new TopDawg takes
first place on the server. 

ts_onjoin_announce <0 | 1>
Disables or enables (default) TerraStats announcing itself to new
players and directing them to ts.help. 

ts_catch_cmds <0 | 1>
Disables or enables (default) the plugin from intercepting comman stats
chat commands such as "statsme", "top10", and "rank" and redirects them
to ts.help. 

ts_default_scheme <scheme name>
Sets the default rating scheme that will be used for TopDawg and
rating calculations in-game. Possible values are: 
    * terrastats
    * localhub
    * globalhub
    * custom1
    * custom2
    * custom3 

ts_localhub_scheme <0 | 1>
Disables (default) or enables the use of the TerraStatsLocalHub
RatingScheme? and its configuration file. 

ts_globalhub_scheme <0 | 1>
Disables (default) or enables the use of the TerraStatsGlobalHub
RatingScheme? and its configuration file. 

ts_custom1_scheme <0 | 1>
Disables (default) or enables the use of the first custom rating scheme
and its configuration file. 

ts_custom2_scheme <0 | 1>
Disables (default) or enables the use of the second custom rating scheme
and its configuration file. 

ts_custom3_scheme <0 | 1>
Disables (default) or enables the use of the third custom rating scheme
and its configuration file. 


CLIENT COMMANDS
The following commands are to be used be players in the game.

ts.help
Console command that displays a description on TerraStats client
commands.

ts.menu
Displays the main TerraStats menu. It is best to bind a key to this
command.

ts.stats
Displays a small box with current rating and Kill:Death ratio.
It is best to bind a key to this command. 

ts.superstats <player name>
Console command that displays indepth statistics on one's self or,
optionally, another player specified by name. 

ts.about
Console command that explains the plugin and lists its developers. 


LICENSE:
TerraStats Copyright 2004, 2005 by HalfLifeTwoDev

TerraStats is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

TerraStats is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with TerraStats; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA


Changes:
Changelog for TerraStats Plugin version 0.6.0:
* All calls to Q_strcat are now Q_strncat.
* Added CVAR support for:
  - ts_debug
  - ts_topdawg_announce
  - ts_onjoin_announce
  - ts_catch_cmds
  - ts_default_rating
  - ts_local_rating
  - ts_global_rating
  - ts_custom1_rating
  - ts_custom2_rating
  - ts_costom3_rating
* Added RatingScheme support.
* Added TerraStats config directory support.
* Added support for Koko Normalization (thanks to KrazyKoko).
* Updated PlayerStats::Rating() to work with RatingSchemes
* Hardcoded default terrastats RatingScheme
* Implemented AfkKill and required code
* Implemented DebugMode
  - prevents people from scoring on empty server when disabled
* ts.debug requires DebugMode, preventing cheating.
* Changed Rating to reflect multiplication on everything.
* AceKills for killing the current TopDawg of the server.
* Rating() parameter can override kokoNormalize.
* Included documentation from wiki in readme.
* Moved copying and readme texts to src directory.
* Enabled CVS.


Changelog for TerraStats Plugin version 0.4.11:
* Updated all console commands to "ts.":
  - ts.help ts.menu, ts.stats, ts.superstats, ts.topdawg, ts.debug
* Updated ts.help with correct information.
* Updated OnJoin message with "ts.help".
* Added new command, ts.about, with info about project.
* Updated ts.help for ts.about.
* Added player name, rating, and ratio to console version of
  superstats (ts.superstats).

Changelog for TerraStats Plugin version 0.4.6:
* Added PlayerWindow support.
* Added Menu support.
* Added Menu support for TopDawg and SuperStats.
* Added support for 3 name aliases to be recorded.
* Fixed incorrect weaponsKills and weaponsDeaths bugs.
* Fixed MapsKills and PlayersKills arrays.
* Incorporated Valve's new GameEvent system.
* Removed '.' from console commands.
* Added console command 'terrastats' to help menu.

Changelog for Terrastats Plugin version 0.1.7:

* Added TheTopDawg announcement at beginning of round.
* Fixed crash at startup.

Changelog for Terrastats Plugin version 0.1.6:

* Formatted .superstats output more nicely.
* Added ability to check other people's stats using .superststs <name>
* Updated .help information concernign .superstats.
* Upgraded game event listner to new version. Faster.
* Changed rating point display to red for negative, blue for positive.
* Added announcement OnJoin.
* Added PlayerAnnouncement function.
* Updated DB version to version 3 (scores will be reset).
* Added HostageAssault, HostageDefense, BombAssault, BombDefense, MissionAssist, TeamworkKill, TeammateSave, and KillStreaks
* Changed AceKill condition to KDRatio of 1.5 or greater.
* Fixed KnifeKill not removing points from victim.