PsychoticNinja/ChanTracker
1
0
Fork 0
mirror of https://github.com/ncoevoet/ChanTracker.git synced 2025-04-26 04:51:07 -05:00
Code Issues Projects Releases Wiki Activity

enhanced documentation

Browse Source
This commit is contained in:
Nicolas Coevoet 2014-01-05 14:58:41 +01:00
parent 04b1ec51cc
commit a3597733dd
1 changed files with 34 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -1,13 +1,39 @@
### ChanTracker : a supybot plugin which do ban tracker ###
This supybot plugin keeps records of channel mode changes, in a sqlite database and permits to manage them over time. It stores affected users, permits to do deep search on them, review actives ones, edit, log, mark lot of them in row.
This supybot plugin keeps records of channel mode changes, in a sqlite database and permits to manage them over time. It stores affected users, permits to do deep search on them, review actives ones, edit duration, show log, mark them, etc
## Commands ##
!affect <id> returns affected users by a mode placed
!b,e,i,q [<channel>] <nick|hostmask>[,<nick|hostmask>] [<years>y] [<weeks>w] [<days>d] [<hours>h] [<minutes>m] [<seconds>s] [<-1> or empty means forever] <reason>) -- +mode targets for duration <reason> is mandatory
!ub,ue,ui,uq [<channel>] <nick|hostmask|*> [<nick|hostmask>]) -- sets -mode on them, if * found, remove them all
!check [<channel>] <pattern> returns list of users who will be affected by such pattern
!edit <id> [,<id>] [<years>y] [<weeks>w] [<days>d] [<hours>h] [<minutes>m] [<seconds>s] [<-1>] means forever) -- change expiration of some active modes
!info <id> returns information about a mode change
!mark id> [,<id>] <message> add a comment about a mode change
!pending [<channel>] [<mode>] [<nick|hostmask>]) -- returns active items for mode if given otherwise all modes are returned, if hostmask given, filtered by oper
!query <text> returns matched modes changes with deep search
!match [<channel>] <nick|hostmask> returns list of modes that affects the nick,hostmask given
!detail <id> returns log from a mode change
!remove [<channel>] <nick> [<reason>] do a force part on <nick> in <channel> with <reason> if provided
## Settings ##
You should increase ping interval, as on channel join bot asks many things and sometimes server takes lot of time to answer
!config supybot.protocols.irc.ping.interval 3600
By default, **bot will not stay opped**, but you can configure that globaly or per channel :
!config supybot.plugins.ChanTracker.keepOp False
!config channel #myChannel supybot.plugins.ChanTracker.keepOp True
Tracked modes are currently defined here ( +qb, and eI ( if opped ) by default ):
If you don't want the bot to manage his own op status, you can change the config value :
!config supybot.plugins.ChanTracker.doNothingAboutOwnOpStatus True
!config channel #myChannel supybot.plugins.ChanTracker.doNothingAboutOwnOpStatus False
Tracked modes are currently defined here ( +qb, and eI if opped ):
!config supybot.plugins.ChanTracker.modesToAsk
!config supybot.plugins.ChanTracker.modesToAskWhenOpped
@ -41,6 +67,8 @@ Bot can set a duration for new tracked mode changes, in order to auto remove the
If ircd is great, bot can track account changes and get gecos/username informations when someone joins a channel, it supports ircd CAP features, details can be found here : http://tools.ietf.org/html/draft-mitchell-irc-capabilities-01
Bot also supports extended bans/quiets like $r,$x,$a, etc if you want it to support your ircd extended bans, please, fill an issue or contact me
It also has a lot of channel protection features, with per channel settings, take a look at config.py for details, but it is able to handle flood, flood from throttle client ( like copy/paste ), repeat message, repeat message from multi users, UPPER CASE spam, channel's CTCP, channel's notices, hilight spam, nick changes spam, join/part flood, mass join, and two more features, bad user flag and channel under attack modes
An example about flood control, You want to quiet for 1 minute anyone that send more than 4 messages in 7 seconds in #channel, and if the user continue to flood, after 2 times he will be banned
@ -51,7 +79,9 @@ An example about flood control, You want to quiet for 1 minute anyone that send
!config channel #channel supybot.plugins.ChanTracker.floodDuration 60
!config channel #channel supybot.plugins.ChanTracker.badPermit 2
Bot will do nothing against user with protected capabilities ( #channel,protected )
You can use k and r as *Mode, which will kick or force part instead of quiet/ban.
Bot will do nothing against user with protected capabilities ( #channel,protected ) and people in +eI list ( supybot.plugins.ChanTracker.modesToAskWhenOpped )
That means if the bot will quiet anyone who flood, and if the user flood more than 2 times during badLife, bot will use badMode on him
@ -60,7 +90,7 @@ Bot will kick by users affected by +b see :
!config supybot.plugins.ChanTracker.kickMode
!config supybot.plugins.ChanTracker.kickMessage
Note : if an op sets mode +b \*!\*@* on #channel by mistake and bot has kickMode enabled in it, it will kick everyone, be warned.
Note : bot will only kick people if the ban was set by itself, if an op place a ban, bot will not kick affected users
It works with any version of supybot, vannila, limnoria etc