mirror of https://github.com/Mikaela/Limnoria.git synced 2024-12-26 04:32:51 +01:00

History

Valentin Lorentz 82fbfcffa4 all plugins: regenerate READMEs		2021-04-17 20:09:33 +02:00
..
locales	Fix msgfmt warnings.	2020-03-26 22:10:28 +01:00
__init__.py	Use importlib instead of imp.	2020-01-26 12:00:08 +01:00
config.py	Fix neutral pronouns.	2014-04-11 21:56:42 +00:00
messages.pot	Squashed commit of the following:	2014-12-20 14:37:27 +01:00
plugin.py	ChannelStats: Skip checks of nick in irc.state.channels[channel] when channel databases are linked.	2020-04-07 21:20:01 +02:00
README.rst	all plugins: regenerate READMEs	2021-04-17 20:09:33 +02:00
test.py	ChannelStats: Fix tests.	2013-01-04 23:03:00 +01:00

README.rst

Documentation for the ChannelStats plugin for Supybot

Purpose

Silently listens to every message received on a channel and keeps statistics concerning joins, parts, and various other commands in addition to tracking statistics about smileys, actions, characters, and words.

Usage

This plugin keeps stats of the channel and returns them with the command 'channelstats'.

Commands

channelstats [<channel>]: Returns the statistics for <channel>. <channel> is only necessary if the message isn't sent on the channel itself.

rank [<channel>] <stat expression>: Returns the ranking of users according to the given stat expression. Valid variables in the stat expression include 'msgs', 'chars', 'words', 'smileys', 'frowns', 'actions', 'joins', 'parts', 'quits', 'kicks', 'kicked', 'topics', and 'modes'. Any simple mathematical expression involving those variables is permitted.

stats [<channel>] [<name>]: Returns the statistics for <name> on <channel>. <channel> is only necessary if the message isn't sent on the channel itself. If <name> isn't given, it defaults to the user sending the command.

Configuration

supybot.plugins.ChannelStats.frowns

This config variable defaults to ":| :-/ :-\ :\ :/ :( :-( :'(", is network-specific, and is channel-specific.

Determines what words (i.e., pieces of text with no spaces in them) are considered 'frowns' for the purposes of stats-keeping.

supybot.plugins.ChannelStats.public

This config variable defaults to "True", is not network-specific, and is not channel-specific.

Determines whether this plugin is publicly visible.

supybot.plugins.ChannelStats.selfStats

This config variable defaults to "True", is network-specific, and is channel-specific.

Determines whether the bot will keep channel statistics on itself, possibly skewing the channel stats (especially in cases where the bot is relaying between channels on a network).

supybot.plugins.ChannelStats.smileys

This config variable defaults to ":) ;) ;] :-) :-D :D :P :p (= =)", is network-specific, and is channel-specific.

Determines what words (i.e., pieces of text with no spaces in them) are considered 'smileys' for the purposes of stats-keeping.