 ______________________________________________
|
| INTRODUCTION
|______________________________________________

   Welcome to multi-network/channel Flood Protection addon for mIRC 6.01+. This addon was meant for preventing flood from users in your channels or in private. It uses "airc.dll" for speed increment and in order to avoid getting lagged from a heavy flood.
   You can open the main dialog from the "Flood Protection" menu or by typing "/fp" (without the quotation) at any command prompt.

 ______________________________________________
|
| ADDING NETWORKS/CHANNELS TO THE LIST
|______________________________________________

   You can add a channel and/or a network in the lists by clicking on the "New" button. You can then add the network fro your settings to take place (or check the "Global network settings" box to indicate that those settings will be available for all networks). Then add the channel you wish to add settings for (or check the "Global channel settings" box to indicate that those settings will be available for all channels) and finally click on the "Confirm" button. You cannot check both "Global network settings" and "Global channel settings" because that means these global settings already exist in "All networks - All channels" option, in the main dialog' s "Network - Channel" selection box.
   To delete a network/channel entry, siply select it from the list and click on the "Rem" button.
   To entirely clear the network/channel list, click on the "Remove all" button. An option to confirm your selection will popup and after you select "Yes", the list will clear.

 ______________________________________________
|
| CHANGING EXISTING SETTINGS
|______________________________________________

   To change the flood setting of an existing network/channel, simply select it from the list and edit its settings. After you finish making your changes click on the "Apply" button (if "Always ask confirmation before saving settings" is enabled from the dialog' s "Options" menu, another dialog will open informing you that you are about to save your changes. Click on the "Yes" button to continue) to save settings for the network/channel you just edited and your self protection settings.

 ______________________________________________
|
| CHANNEL FLOOD PROTECTION
|______________________________________________

   The first four main dialog' s tabs have the channel' s flood protection settings.
   The first of these tabs have options for text, action, notice, CTCP, nick, join, repeat and byte flood.
   The second tab contains options for mode flood and flood against multiple users, that is massive op, deop, kick, ban, unban, mode and topic change.
   The third one contains options for control-character flood, character flood (long text) or capital letter flood, within a sentence, whether it is a text, action, notice or CTCP message. The "or" option allows you to kick a user if he uses a total amount of control characters (meaning color, bold, underline and reverse characters in any proportion). For example if you have set 5 as a total value and the user uses 3 color characters 1 underline character and 1 bold character, he will get punished according to your punishment settings.
   Finally, the fourth tab contains the punishment and protection options for the users flooding the selected channel. Select punishment for flooding (if kick/ban is selected as a punishment, you can also set the banmask and the ban time. If kick or kick/ban is selected as a punishment you can also select whether you want a filter kick or not) and then select the protection options as you like. The "Filter kick" option enables you to kick all users from the same location as the flooder (for example, if the user is using clones to make a flood). To protect users who flood the channel and they' re operators, half-operators, voiced users in it and/or users who are in your notify list check the corresponidng boxes.

   Note 1: Punishment for flooding with capitals will trigger if the characters in sentence are at least 10. If sentence contains less than 10 characters, punishment won' t trigger.

   Note 2: Protection for oped, half-oped and voiced users will not trigger on join, op, deop, kick, ban, unban, mode and topic change flood. Only users in your notify list will be protected if such flood occurs, and only if you have enabled that option.

 ______________________________________________
|
| SELF FLOOD PROTECTION
|______________________________________________

   The fifth tab contains options for stopping a private flood against you. Firstly, select the ignore mask, that is the mask of the ignore you' ll place on the user who floods you in order to avoid further annoyment. Then select the time to ignore that user in minutes or whether the ignore will be a permanent one. Finally, you can select to kick or kick/ban that user (if he is in a channel or channels you are also in), if the users in your notify list will be excluded from punishment and whether or not flooders will receive a notice from you informing them that they have been flooding you and that they have been added in your ignore list for that purpose.

 ______________________________________________
|
| ENABLING/DISABLING OPTIONS
|______________________________________________

   You can enable an option by checking its corresponding box on the left. If an option is disabled, some other settings may also become disabled until you enable that option again. That is done for your convenience, in order to get a better view of your settings.

 ______________________________________________
|
| BAN/IGNORE MASK SYMBOLS
|______________________________________________

   When selecting a mask for ban or ignore you can select between ten address types.
   The address of a user is in the form of n!u@h. The "n" symbol means "nickname", the "u" symbol means "user ID" and the "h" symbol means "host". For example if a user' s address is RagingDemon!daredevil@vdp001.ath02.cas.hol.gr, then the nick is "RagingDemon", the user ID is "daredevil" and the host is "vdp001.ath02.cas.hol.gr". If you have selected banmask number 2 which is *!*@h then your ban will be on "*!*@vdp001.ath02.cas.hol.gr". For more information about masks please refer to mIRC' s help file or any other appropriate sources.

 ______________________________________________
|
| FLOOD PROTECTION PRIORITY
|______________________________________________

   The priorities used to get the valid flood protection settings are:
      1. Channel/Network specific setting (Specific network - Specific channel)
      2. Channel specific setting (All networks - Specific channel)
      3. Network specific setting (Specific network - All channels)
      4. Default, global setting (All networks - All channels)

   (The above paragraph is a modified version of airc.dll' s function file' s "Flood2" paragraph, in order to get the general idea of how this addon works).
   That means that if you have settings for a specific network and a specific channel, those settings will used. If the addon cannot find these settings it will then search for channel settings, regarding the network parameter. If these settings cannot be found too, then a search for your current network will begin. If you have not stored any settings for your current network, then the global settings (All channels - All networks) will be used instead.

 ______________________________________________
|
| THE "File" AND "Options" MENU
|______________________________________________

   From the "File" menu you can insert the default values into all boxes, for your current network/channel and self protection settings. But remember that those settings will NOT be saved unless you also click on the "Apply" button.
   From the "Options" menu you can set the kick or ignore reasons by selecting "Modify kick/ignore reasons". You can also disable the whole flood protection by selecting "Completely disable channel flood protection" and/or "Completely disable self flood protection", you can select not to kick or kick/ban users who flood channel if you are away, by checking "Disable flood punishment while away" (if you are away, self protection' s common channel kick and kick/ban will also not be applied) and finally you can select the "Always ask for confirmation before saving settings" in order to be prompted before saving , that you are about to make changes to your current network/channel and self protection settings.

 ______________________________________________
|   
| IMPORTANT NOTE - REMINDER (PLEASE READ THIS)
|______________________________________________

   Settings in tabs "Chan 1", "... 2", "... 3" and "... 4" are meant to be network/channel dependent. Before clicking on the "Apply" button remember to check the editbox containg the network/channel' s name. Your settings in ALL those 4 tabs will be saved for THAT network/channel.
   The "Self" tab though, is network-independent. This means that your settings there, will apply to ALL networks.

 ______________________________________________
|
| EXAMPLES OF SETTINGS (PLEASE READ THIS)
|______________________________________________

   At first, let' s say you want to add flood settings for a specific channel of a specific network. In our example it will be channel #lobby for TestNET. The steps are pretty easy and are described below:

   1. Open addon' s main dialog (either type "/fp" - without the quotation - anywhere or right-click on a channel' s main window, on your Status window or select to open it from your mIRC' s menubar, from the "Flood Protection" menu)
   2. After you' ve opened the dialog, click on the "New" button and a new, smaller dialog will open.
   3. On the new dialog that just opened, you can see a box named "Add new network:" which contains an editbox to type the network' s name and a checkbox which is named "Global network settings". We want to add settings for network TestNET, as mentioned above, so we type that name into the editbox.
   4. Now we move down to the second box named "Add new channel:". This one also contains an editbox for typing your channel' s name and a checkbox named "Global channel settings". We want settings for channel #lobby, so we type its name into the editbox.
   5. We now click on the "Confirm" button and the settings are added.

   You can see that in the main dialog' s combobox the selected option is "TestNET - #lobby". If you want to change any settings for that option, make your changes in the 4 first tabs and click on the "Apply" button.

   Now let' s say that we do not want a specific network, but only a specific channel, #lobby... We follow steps 1 and 2 as written above but in step 3, instead of typing a name for our network, we check the "Global network settings" box. Now we move on and follow the rest steps as written. The difference now is that in the main dialog, option "All networks - #lobby" is selected. This in simple words means that you have added settings for channel #lobby in ANY network you are into.

   And what if you want to add settings for all channels of a specific network, TestNET for example? You follow steps 1, 2 and 3 and at step 4 instead of typing a channel' s name into the editbox, you check the "Global channel settings" box. You follow the next steps as are. You can now see on the main dialog the option "TestNET - All channels" selected. That means that the flood settings below, will apply to ALL channels of network TestNET.
 
   Lastly, what if you don' t want any specific channels and networks and just want global settings for everything? In that case, you DON' T click on the "New" button on the main dialog, but you simply select "All networks - All channels" form the main dialog' s combobox, edit those settings and finally click on the "Apply" button.

   Remember that "All networks - All channels" option represent your global settings.
   Please have in mind the addon' s punishment priorities. (View the "FLOOD PROTECTION PRIORITY" section above, for more information)

 ______________________________________________
|
| CREDITS - MISCELLANEOUS INFORMATION
|______________________________________________

   Addon version:
          2.0

   airc.dll written by:
          Gustavo Picon (tabo) * http://www.airc.ws

   mIRC code written by:
          Thanasis K (RagingDemon) * gren_gr@yahoo.com

   Addon tested by:
          ORSO
          RagingDemon

   Special thanks to:
          mircscripts.org for hosting addon * www.mircscripts.org
          all people commenting on it, helping me to improve it

   For version updates please read the "fp_versions.txt" file or select "Version updates" from the "Help" menu.
   Thank you for using Flood Protection addon. I hope you find it useful. For any bugs/comments/suggestions, feel free to e-mail me. I can also be found in #scripting on GRNet (type "/server -m gr.irc.gr" or "/server -m warrior.irc.gr", without the quotation, to connect).

 Copyright 2004

______________________________________________

"Three words of destruction: Shun-Goku-Satsu"