Update to version 2.9.2d
[tropbot.git] / README.txt
index 55b7d7f..5bff2f7 100644 (file)
@@ -1,5 +1,5 @@
 -------------------------------------------------------------------------------
-  TropBot v2.5
+  TropBot v2.9
   Documentation written by Francois Fleuret
   Contact <francois.fleuret@inria.fr> for comments & bug reports
   Check http://www.eleves.ens.fr:8080/home/fleuret for latest version
@@ -20,7 +20,8 @@ EFNet. After few months, TropBot became a real bot, with many
 features. He's still a fast and small bot, but he can defend a channel
 by himself. The version 2.2.0 was so stable that I have run one on
 #france for longer than one month with no reboot (when I finally
-killed it it was just to run a newer version).
+killed it it was just to run a newer version). The last version
+(2.9.0) runs under Purify(tm) with no error.
 
 -------------------------------------------------------------------------------
 II - TROPBOT CAPABILITIES -----------------------------------------------------
@@ -82,6 +83,18 @@ of the net, there are no flood detection and you won't loose the
 connection even if the bots send you a lot of datas, etc. This kind of
 connection is great for commands like "who" "help" "shitlist" etc.
 
+Since v2.8.0, TropBot has new features to handle big channels. First,
+it has in memory a list of 'restricted' sites. The bot will detect and
+kick/ban any group of users who are on the same machine. The main idea
+is to protect the channel from clone bots. The second important
+feature is the 'cop-mode'. When this mode is switch ON, the bot will
+detect any graphical effect (caps, reverse, mIrc colors, beeps,
+art-chars, repeated chars, etc.), wil also ban any user who is kicked
+3 times or more in less than 10 minutes, and will ban all site where
+more than 3 people are banned.
+
+The v2.9.0 is a more stable version, debugged using Purify(tm)
+
 -------------------------------------------------------------------------------
 II - HOW TO INSTALL TROPBOT ---------------------------------------------------
 -------------------------------------------------------------------------------
@@ -181,6 +194,12 @@ FRIEND 2 *!*@*.fr trululu
 will make all people from France able to execute functions with a
 level 2 if they use the password trululu.
 
+You can also specify a list of restricted sites. For example, if you
+want to avoid to have more than one personne on a same adress
+containing "ppp", just put
+
+RESTRICTED *!*@*ppp*
+
 -------------------------------------------------------------------------------
 V - TROPBOT FUNCTIONS ---------------------------------------------------------
 -------------------------------------------------------------------------------
@@ -212,6 +231,8 @@ usefull against clone bots.
 anti-flood system for the given duration. This feature is interesting
 when the bot lagged because of network troubles.
 
+"cop" switch the cop-mode on/off
+
 "deban { list of patterns }" (alias "db") remove from the ban-list all
 the entries who match one of the pattern
 
@@ -315,7 +336,8 @@ VI - CONCLUSION/BUGS ----------------------------------------------------------
 A bot is a complex program. This one, even if it's not very long has
 to deal with many buffers and strings operations. Such kind of program
 can't be 100% safe. I hope current version is stable, but I fear some
-buggs are still creeping somewhere.
+buggs are still creeping somewhere. The last version was checked with
+Purify and is supposed to be kinda stable.
 
 -------------------------------------------------------------------------------
 - AUTHOR ----------------------------------------------------------------------
@@ -330,12 +352,6 @@ I really DON'T appreciate questions about compilation, and I HATE
 questions whose answers are in this file. I appreciate suggestions and
 bug reports :P
 
-Snail mail :
-
- Francois Fleuret
- 16 Rue Pasteur
- 78330 Fontenay le Fleury, FRANCE
-
 -------------------------------------------------------------------------------
 - ACKNOWLEDGEMENT -------------------------------------------------------------
 -------------------------------------------------------------------------------