README.TXT
plugin_sank_nameban
November 15, 2002
FOr AdminMod version 2.50.50 or newer.
http://www.adminmod.org


Table of Contents:
===============================================================================
1. Files Included
2. Plugin Description
3. Plugin Commands
4. Installation Instructions
5. NameBanList.txt Help Guide
6. Revision History


1. Files Included:
===============================================================================
README.TXT - This file.
plugin_sank_sounds.sma - Plugin source.
plugin_sank_sounds.amx - Compiled win32 version.
plugin_sank_sounds_l.amx - Complied linux version.
NameBanList.txt - sample file.


2. Plugin Description:
===============================================================================

Bans players based on their name.  If a player connects with a name that
contains one of the entries listed in the text file, then they will get banned.
If a player changes their name to one of the offending names, they will also
get banned.

In the event that this plugin bans somebody, it will write a log to its own log
file, NameBanLog.txt which contains entries with Date, Time, Name, and WONID:
L 01/02/02 12:23:34 - mygOt<54321>
L 01/02/02 12:34:56 - myg0t<12345>


3. Plugin Commands:
===============================================================================

admin_nameban
 Prints out list of names that get banned.
 Usage: admin_nameban
 Access required: ACCESS_ALL


4. Installation Instructions:
===============================================================================

Linux guys be sure to specify the -a flag when unzipping the text files so that
the line ends are converted properly.

1.) Put the plugin_sank_nameban.amx (plugin_sank_nameban_l.amx if you run
linux) file in your mod's addons\adminmod\scripts directory, as described in
the Admin Mod installation guide, and modify your
addons\adminmod\config\plugin.ini file to include the line,
addons\adminmod\scripts\plugin_sank_nameban.amx" (plugin_sank_nameban_l.amx
if you run linux) also as described in the Admin Mod installation guide.  The
antiflood plugin should be the very first entry in the plugin.ini file for
maximum effectiveness.

2.) Put the NameBanList.txt file in your Admin Mod's config directory, for
example, "..\half-life\cstrike\addons\adminmod\config\NameBanList.txt" or
"..\hlserver\%MOD%\addons\adminmod\config\NameBanList.txt"

3.) There are two CVARS that affect this plugin: file_access_read and
file_access_write.  file_access_read is required to be set at 1, and
file_access_write is required to be set at 1 to log the name-banned people.

4.) That's It!


5. NameBanList.txt help guide:
===============================================================================

The script reads in one line at a time. Lines beginning with a '#' or '//' are
ignored.  Each line shall contain one name to ban.  It can either be an exact
name, or a partial name.  The default is to match a partial name, but if you
desire to list exact names, then you can #define EXACTNAME on line 34 of the
SMA file and recompile according to the instructions in the Admin Mod help
guide.


6. Revision History
===============================================================================
 * November 25, 2001 - Original version
 * February 15, 2002 - Added some debug code because of incorrect bans and
 *  the option for exact names to ban, or just partial names to ban
 * November 15, 2002 - Updated file locations to be compliant with the new
 *  directory structure.  Also, updated the debug code with contact
 *  information.


That should give you the details to be an expert, if you have any questions or
bug reports, contact info is in the Plugin Description section.

Luke Sankey
sank@spu.edu