//////////////////////////////////////////////////////////////////////
//                                                                  //
//                    BANNING DOCUMENTATION                         //
//                                                                  //
// Time-stamp: <2001-06-16 02:52:06 hogsett>
//////////////////////////////////////////////////////////////////////

//////////////////////////////////////////////////////////////////////
//                               NOTE                               //
// In this installion document I make the assumption that Starsiege //
// has been installed in "C:\Dynamix\Starsiege\".  If it has been   //
// installed in a location other than "C:\Dynamix\Starsiege\"       //
// replace that path below with the actual path to where Starsiege  //
// is installed on your computer.                                   //
//////////////////////////////////////////////////////////////////////

The banning feature provided by the BoP Standard Library uses a data
file to look up banned player names and IP addresses.  For the banning
feature to work the file "BoP_Banned.cs" must be located in 
"C:\Dynamix\Starsiege\".  If you read and followed the instructions in 
the "INSTALL.txt" file included with this map pack you have already 
installed it at that location.

The contents of the "BoP_Banned.cs" file as included in this map pack
is as follows : 

$Banned::addr0 = "IP:192.168.1.1";
$Banned::name0 = "\\";
$Banned::name1 = "<r";
$Banned::name2 = "<R";
$Banned::name3 = "<y";
$Banned::name4 = "<Y";
$Banned::name5 = "unknown";
$Banned::name6 = "iambanned";

The first line (rule) serves as an example for banning IP addresses. (Don't
worry you can leave that rule in the file, no valid starsiege player
should have that address.)

To add a second rule to the list of banned IP addresses simply 
duplicate the last addr rule, increment the addr index by one and change 
the IP address to the IP address you want to ban.  For example two new
addr rules may look like : 

$Banned::addr1 = "IP:127.0.0.1"; 
$Banned::addr2 = "IP:10.0.0.1"; 

Adding banned names to the rules list follows the same method as that 
for adding addresses, except you add entries to the name list instead.

You can use partial IP addresses or names within the rules.
For example the following entry : 

$Banned::addr3 = "IP:24.";

Would ban anyone who's IP address begins with "24." ( which would be 
many members of our squad ).  The "IP:" at the beginning is REQUIRED.
If you leave out "IP:" at the beginning of the address the rule will
fail to work.

Likewise the following rule : 

$Banned::name7 = "m";

Would ban ANY player who's name begins with a lower case "m".

PLEASE NOTE : 

	1) The entries are CASE SENSITIVE.  Banning "m" is not
           the same as banning "M".  

        2) You can't skip entries in the file.  If you have rules
           for name0, name2 and name3, but not for name1, it will
           ignore all rules following the missing entry, in this
           case name2 and name3.

        3) A player will be banned by the first rule which matches.
           Their name is checked first then their IP address.

	4) The banning system is somewhat lame.  By supporting 
           partial entries the rule : 
           
               $Banned::name0 = "John";

           Will ban anyone who's name begins with "John" such as 
           "JohnBoy" or "Johnny" as well as "John".  Try to ban 
           the longest name possible, or consider banning only 
           by IP address.  (If the entry was added via remote 
           administration edit the file manually to remove the
           name or names.)

	5) To Remove someone from the ban list it may be necessary to
           remove their name from the name list, their IP address from
           the addr list, or both. If you are not sure which list entry
           is banning someone look at the log file (normally 
           C:\Dynamix\Starsiege\BoP_ServerLog.txt).  It logs the rule
           which caused a player to be banned.  It may be necessary to
	   remove 1 or more rules.

	6) The host of a non-dedicated server is NEVER BANNED, regardless
           of their name or IP address.
