#Readme file for anti-flood/monologue bot
Was originally written in perl and depended on perl 5.10 features, it was then rewritten with python.
##Dependencies Python version 2.7 or later (would probably work with older python versions too) and [aidsbot] 1 IRC bot library.
##Usage start the script by simply chmodding it to executable and do ./monologue.py (/path/to/config) or write the command python monologue.py (/path/to/config)
##Configuration The configuration is in a simple file that is either monologue.conf in the same directory as the script or given to the bot on the commandline
It expects 9-10 options to be set and it will bark at you if you have too many/few options. Comments starts with a hashtag #
- nick = The nick the bot will use when it connects to the irc network, will also be it's ircname in whois
- server = The irc server to connect to
- port = The port of the irc server to connect to
- flood_limit = The amount of messages that is allowed to paste before being kicked (actually it is this number + 1, it kicks the next message after this limit has been reached)
- flood_kick_msg = The floodkick msg to be told to the person kicked
- monologue_limit = Same as flood_limit but regarding monologging instead of flooding
- monologue_kick_msg = Same as flood_kick_msg but when kicking for monologging
- channels = Comma delimited list of channels to join on the server chosen
- irc_password = An irc password that makes it possible to identify to nickserv (has to be created beforehand and manually and it is optional)
- flood_time = The time between messages that is considered flooding, usually 1-1.5s is enough to stop those flooding but save those that just type rather fast
##TODO
- Making a !exit and !restart command that has a whitelist as a comma delimited list in the config file
- Whitelist of which people are excempt from being kicked by the bot as a comma delimited list in the config file, like ops and voiced people