*** 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 /flood 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 0 to 9 characters, punishment won' t trigger.
   * Note 2: Protection for oped, half-oped and voiced users will not trigger on 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.
   

*** CREDITS ***

   Addon version:
          1.7

   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:
          Lionheart7
          Take0n
          RagingDemon

   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"