//////////////////////////////////////////////////////////////////////
//                                                                  //
//                    key bindings documentation                    //
//                                                                  //
// Time-stamp: <2001-06-16 03:23:13 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 adminstration features provided by the BoP standard library
require that certain new key bindings be available in the game.  These
key bindings enable the player (client) to send commands to the
server.  Without these key bindings installed the client will have no
access to the administration features, therefore it is required that
anyone needing remote administration install these key bindings.

Installing the key bindings is best accomplished by inserting the
following lines into the c:\dynamix\starsiege\scripts\quickchat.cs
file.

All of the following lines can be inserted into the quickchat.cs file
unchanged : 

bind(keyboard0, make, "control", "b", TO, "remoteEval(2048,\"ban\");");
bind(keyboard0, make, "control", "e", TO, "remoteEval(2048,\"endMission\");");
bind(keyboard0, make, "control", "k", TO, "remoteEval(2048,\"kick\");");
bind(keyboard0, make, "control", "m", TO, "remoteEval(2048,\"cycleCD\");");
bind(keyboard0, make, "control", "s", TO, "remoteEval(2048,\"toggleScanAuth\");");

The following line is special.  Its purpose is to send the password to
the server to log in to it as an admin.  Because of this it needs to be 
edited to send the password.  To do so, replace the YOURPASSWORD portion 
with the password as it appears in the server's "BoP_Admins.cs" file.
The \" are required on either end of the password.

bind(keyboard0, make, "control", "l", TO, "remoteEval(2048,\"login\",\"YOURPASSWORD\");");

If your password was "test" the line would appear in the quickchat.cs file as : 

bind(keyboard0, make, "control", "l", TO, "remoteEval(2048,\"login\",\"test\");");

Included in this distribution is a file named append-to-quickchat.cs.
It contains the lines above that are required to add to your
quickchat.cs file.  All that needs to be done is to change
YOURPASSWORD to the password as it appears in the server's
"BoP_Admins.cs" file and insert the lines into the begining of your
quickchat.cs file.

Please see ADMIN.txt for additional information regarding the
administartion features provided by the BoP Standard Library.
