mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-19 08:59:27 +01:00

History

Valentin Lorentz db7ef3f025 all: Add generic 'The Limnoria Contributors' to copyright notices. No need to bother with details (that are all outdated / out of sync anyway), just look up the git history.		2021-08-01 21:54:49 +02:00
..
__init__.py	all: Add generic 'The Limnoria Contributors' to copyright notices.	2021-08-01 21:54:49 +02:00
config.py	all: Add generic 'The Limnoria Contributors' to copyright notices.	2021-08-01 21:54:49 +02:00
handler.py	all: Add generic 'The Limnoria Contributors' to copyright notices.	2021-08-01 21:54:49 +02:00
plugin.py	all: Add generic 'The Limnoria Contributors' to copyright notices.	2021-08-01 21:54:49 +02:00
README.rst	all plugins: regenerate READMEs	2021-04-22 00:29:15 +02:00
test.py	all: Add generic 'The Limnoria Contributors' to copyright notices.	2021-08-01 21:54:49 +02:00

README.rst

Documentation for the LogToIrc plugin for Supybot

Purpose

Allows for sending the bot's logging output to channels or users.

Configuration

supybot.plugins.LogToIrc.channelModesRequired

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

Determines what channel modes a channel will be required to have for the bot to log to the channel. If this string is empty, no modes will be checked.

supybot.plugins.LogToIrc.color

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

Determines whether the bot's logs to IRC will be colorized with mIRC colors.

supybot.plugins.LogToIrc.level

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

Determines what the minimum priority level logged will be to IRC. See supybot.log.level for possible values. DEBUG is disabled due to the large quantity of output.

supybot.plugins.LogToIrc.networks

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

Determines what networks the bot should log to. If no networks are set, the bot will log on one network (whichever happens to be around at the time it feels like logging).

supybot.plugins.LogToIrc.notice

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

Determines whether the bot's logs to IRC will be sent via NOTICE instead of PRIVMSG. Channels will always be PRIVMSGed, regardless of this variable; NOTICEs will only be used if this variable is True and the target is a nick, not a channel.

supybot.plugins.LogToIrc.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.LogToIrc.targets

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

Determines which channels/nicks the bot should log to. If no channels/nicks are set, this plugin will effectively be turned off.

supybot.plugins.LogToIrc.userCapabilityRequired

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

Determines what capability is required for the bot to log to in private messages to the user. If this is empty, there will be no capability that's checked.