
               -----------------------------------------------------
                 -------------------------------------------------  
                 Instructions for plugin_logd_cavey_tk.sma 1.2    
                 -------------------------------------------------  
               -----------------------------------------------------
                          Last revised 14:17 20/06/2002

	1) How do I install this?
	2) What extra functions does this add to my server?
	3) How do I use the new functions?
	4) How can I configure this plugin then??
	5) It isn't working, what is wrong with it?
	6) Any questions??

///////   1) How do I install this?  ////////////////////////////////////////

-----Win32------

1) Place the uncompiled .sma in ../halflife/admin/scripting/myscripts.

2) Edit the .sma in a text editor.Dont forget to add the command you want 
   to log to the "loggedcmds.ini" file.

3) Doubleclick the compile_all.bat 

4) Find the ../halflife/admin/scripting/mybinaries directory and copy the 
   .amx files. 

5) Paste the .amx files into the ../halflife/{moddir}/dlls directory. 

6) Add the names of the plugins to the plguin.ini in the {moddir}, ie for 
   plugin_cavey_adminlog.amx add "dlls/plugin_cavey_adminlog.amx" to the
   TOP of the file. If you do not put it at the top, it will NOT work!!

7) Set file_access_read and file_access_write to 1 in your server.cfg
   If you dont, this will NOT work!!!!
   For the bury function allow_client_exec 1 has to be set

8) Create a directory called "adminlogs" in the {moddir} and paste in the 
   "loggedcmds.ini".  If there is a command you want to monitor that is not 
   in the "loggedcmds.ini", just add it as a new line to the bottom of the 
   file.  If you dont do this, it will sit there logging NOTHING.

9) The command "admin_adminlog" is available to those who have "ACCESS_RCON"
   priviledges.  It should talk you through the process of making changes 
   to the config.

-----Linux------

As Win32, but use compile_all.sh instead of compile_all.bat

///////   2) What extra functions does this add to my server?  ////////////////

The extra functionalities it has are as follows.

 * So, some Brat comes on your server and tks you.  You are out for blood, you 
   want to nail him to a wall by his pre-pubescent testicles, your 20 for 1 
   average is now ruined and you are positively seething.  This provides a method 
   for revenge.  THe options are "Forgive", "Nothing now", "Slap", "Slay", "Kick"
   "Temp Ban" and "Perm Ban".  Now I wholly understand that you wont want people
   to immediatly ban the guy for one TK, so this allows you to set levels of TKing.
   At each level a new option appears on the list for you to choose from.

 * Where this plugin differs from most is that it holds individual TK records.
   You can only forgive a person if they have TK'd you, so you cant forgive for
   someone else's TKs.  THe level at which they are punnished is still counted
   on how many TK's they have comitted globally.

   Example-	Assume Bob killed Bill.  Bill now has the option to "Forgive", 
		"Nothing Now" or "Slap".  If Bill chooses "Forgive", the TK is 
		removed from Bob and his Global TK's decrease.  Suppose Bill
		chooses "Nothing Now" and Bob kills Bill a few more times, Bill
		will see the "Slay" option appear on his menu.  Also, if Bob goes
		off to TK Kate and Fred a few times, Bill  can call his TK menu 
		through "admin_tkmenu" and see who has TK'd him.  As Bob will be 
		on the list, he can punnish Bob to the limit of the Level at which
		Bob is globally, even though Bob only TK'd him once.  

 * To stop repeated punnishments there is the option to forgive a TK when someone
   selects a punnishment, but this can be disabled so people can just increment 
   their TKs ad infinitum (or until they get kicked).

///////   3) How do I use the new functions?  //////////////////////////////////

The plugin itself is designed to be install and forget.  Once installed it will 
set itself up using the default settings (see section 4) that I defined while
I was writing it.  These settings are designed to leave the plugin running 
maximum fucntionality and minimum greif.  Tweaking details are in section 4.

///////   4) How can I configure this plugin then??  ///////////////////////////

In your vault file you should find that you have the variables listed of

	TK_LEVEL_ONE
	TK_LEVEL_TWO
	TK_LEVEL_THREE
	TK_LEVEL_FOUR
	TK_LEVEL_FIVE
	TK_LEVEL_REDUCE_ON_REVENGE
	

But what does each of these define and how can I edit them?

	TK_LEVEL_ONE
Defines the number of global TKs that are required to bring the "Slap" function into
the menu.  Default is 0.

	TK_LEVEL_TWO
Defines the number of global TKs that are required to bring the "Slay" function into
the menu.  Default is 3.

	TK_LEVEL_THREE
Defines the number of global TKs that are required to bring the "Kick" function into
the menu.  Default is 9.

	TK_LEVEL_FOUR
Defines the number of global TKs that are required to bring the "Temporary Ban" 
function into the menu.  Default is 10.

	TK_LEVEL_FIVE
Defines the number of global TKs that are required to bring the "Permanant Ban" 
function into the menu.  Default is 20.

	TK_LEVEL_REDUCE_ON_REVENGE
This defines whether people loose TKs when they use the revenge commands.  Setting this
to 0 disables this feature and may lead to abuse through people repeatedly punnishing 
people, but I thought I would give you the option.

	TK_INSTANT_SLAY
This sets the plugin to immediatly slay the user.  Otherwise it will slay them at the 
start of the next round.  This makes more sense as it makes it more likely that they 
are alive. Default is 0 (off) (it will slay them on round start)

///////   5) It isn't working, what is wrong with it?  ///////////////////////////////

Okay, a list of symptoms and problems in the order that you ought to check them.....

Symptom		- It is not compiling when I click the compile_all file and the amx
		  is 0 bytes in size.
Possible Causes	- Are you using the correct version of the AdminMod?  This now requires
		  AdminMod 2.51 or newer.
		- Okay, for this you need to check for a new version of the plugin from
		  http://gosh.ex.ac.uk/~py99jan/ . If the version available there still
		  has the problem I will want you to e-mail me the plugin_logd_cavey_tk_error.txt
		  file or ICQ me about the problem.  Please see the details at the bottom
		  of this file.

Symptom		- I dont see any menus, where are they?
Possible Causes	- Are you using the correct version of the AdminMod?  This now requires
		  AdminMod 2.51 or newer.
		- Have you enabled the BETA cvar?  If not, put 
			amv_enable_beta "menu 1"
		  in your server.cfg (listenserver.cfg for non-dedicated servers)

Symptom		- It is not registering any TeamKills.
Possible Causes	- You do have LogD installed dont you?  In the HLDS console or over rcon
		  type in "meta list" and see if LogD is listed as having any problems.

Symptom		- The bury function doesn't work.
Possible Causes	- Set allow_client_exec 1 in the adminmod.cfg


I have not found any other problems, if you find one, please tell me......

///////   6) Any questions??  ////////////////////////////////////////////////////////

Author     - Joe "Caveman" Noyes

A/S/L      - 20/Male/Exeter and Droitwich Spa, England.

ICQ#       - 70710878
Home Page  - http://gosh.ex.ac.uk/~py99jan/
E-mail/MSN - dmcaveman@hotmail.com
