**************************
* Flood Protection Addon *
*       By Pasmal        *
**************************

************
* Overview *
************

This script checks for seven different types of floods (private message, channel message, private
notice, channel notice, private ctcp, channel ctcp, nick change) and then can do one, two or three
of the following options: Ban user, Kick user, Add the user to your ignore list.


***********
* Install *
***********

This script REQUIRES mIRC 5.51 or higher.

Unzip flood.mrc and flood-help.txt(this file) and hd.bmp to any folder on your hard drive
though it would make sense to put these files in a mIRC related folder like c:\mirc
but its up to you. Once you have done that, open up mIRC and in any editbox type:

/load -rs c:\wherever-you-put-flood.mrc\flood.mrc

e.g. Lets say you put flood.mrc in c:\addons you would type:
/load -rs c:\addons\flood.mrc

The script will now be loaded.

************************************
* Configuring The Flood Protection *
************************************

First things first, you must enter channel(s) on where you want this script to work in. To do this
goto the Menubar popups/Flood Protection/Channels List. From there you can add & remove channels.

Next you have to configure the actual flood settings. To do this click on the Settings popup in the
Flood Protection popup. From here you can select each of the different flood types via a drop down list.
Once you have selected a flood type you can edit its settings. You can:

Turn it on (Via the Enable.... checkbox)
Change its sensitivity by altering the "x" lines in "x" seconds sentance. I recommend a default of
5 lines in 3 seconds for Channel Text,Private Text,Channel Notice & Private Notice. For Channel
CTCP & Private CTCP I recomend 5 lines in 4 seconds. For the Nick Flood I recomend 5 /nicks in
20 seconds.

To set what the script should do when It detects a flood of the selected type:

If you want to kick the user, check the "Kick User" checkbox.  This will kick the user out of every channel
that the flood script is protecting.

If you wnat to ban the user, check the "Ban User" checkbox. This will ban the user in every channel
the flood script is protecting. You will also need to fill in the ban length (If you don't want the
ban to unban set the ban length to 0). You also need to set the ban mask for the ban. I recomend a 
ban mask of 3 or 2.

If you want to add the user to your ignore list: 

Check "Ignore User". Be sure to fill in the "Ignore Length". Something like 60 seconds on ignore seams
reasonable to me. 

NOTE: When setting the number of seconds, just write the number and don't put secs after it. e.g. Lets
say I wanted to ban the user for 50 seconds, I would put 50 into the Ban Length edit box. I would
NOT PUT 50secs into the edit box. 

If you want the script not to kick/ban the user in a channel that he is an op in (but the script will still
kick him in channels that he is not an op in), check the "Exclude Ops" checkbox.

***********************
*  Other Information  *
***********************

#HelpDesk WebSite: http://www.helpdesk.mircx.com
#HelpDesk Scripts Deposit: http://www.helpdesk.mircx.com/scripts (Click on the #HelpDesk Now logo to visit it)
Pasmal's Homepage: http://homepages.ihug.co.nz/~mcopley
Pasmal's Email: mcopley@ihug.co.nz

Please do not rip this script.



