Modules/2.0/censor

From the makers of InspIRCd.
Jump to: navigation, search

censor module (2.0 version)

Current Future
2.0 Documentation 3.0 Documentation
Return to the 2.0 Module List
Description
Allows filtering of text from private and channel messages and notices, based on a set of patterns defined in the Configuration files. Unlike m_filter, this module is designed for users to control their channels where m_filter is designed for admins to control entire irc servers.
Configuration Tags
To use this module you should add the following tags to your Configuration file:
<badword text="shit" replace="poo">

The patterns used are straight search and replace operations which match against any PRIVMSG or NOTICE command from oper and user alike (no exceptions) to the channel or user that has mode +G set upon it. The text given will be replaced, and replacement does not diffrentiate between word boundaries, e.g. the example given above would replace 'shitake mushrooms' with pooake mushrooms'. You have been warned!

Modes
 
  • User mode +G: Filters out censored words from private messages to a user
  • Channel mode +G: Filters out censored words from messages to a channel
Extended Bans (Extbans)
This module implements no extended bans.
Commands
This module adds no extra commands.
Special Notes
Please note that search and replace operations are faster to match than regular expressions (such as those used in unrealircd, etc), however a large number (e.g. a hundred or more) of them can still impede performance. In addition, the more users you have, the less patterns you will be able to have without crippling your irc server. Filtering is always done locally, so if you have over 2000 users per server, consider other alternatives where possible.