Skip to content
SatomiAhn edited this page May 11, 2012 · 2 revisions

Badwords plugin

Purpose

Badwords plugin makes it possible for an owner to set a list of forbidden words which will trigger a punishment (typically: shock animation) when said in chat by the collar wearer. The wearer can make the punishment stop by saying the penance sentence in chat.

Bundle

This plugin belongs to ExtraShock bundle, which is not installed by default.

Menus

Badwords plugin menu can be reached by clicking the button Badwords in AddOns submenu.

This menu has the following buttons:

  • List Words: lists all bad words to the menu user.
  • Clear All: removes all bad words from previous list.
  • Say Penance: outputs the current penance to the menu user.
  • On/Off: enables/disables badwords plugin.
  • Quick Help: outputs a short help text to the menu user.

Commands that actually change badwords settings are restricted to primary owners only.

Note that most features, as they require a text input, are only accessible through chat commands and not from the dialogs.

Chat commands

Auth plugin answers to the following chat commands:

  • menu badwords or badwords: pops up the BadWords menu.
  • badword <list_of_words_separated_by_spaces>: adds the words of the list to the list of bad words. Turns the bad words plugin on if new words were added.
  • rembadword <list_of_words_separated_by_spaces>: removes the words of the list from the list of bad words.
  • badwordsanim <animation_name>: sets this animation as the punishment.
  • penance: displays the penance phrase.
  • penance <phrase>: sets this phrase as the new penance.
  • badwords on/badwords off: turns on/turns off the plugin.
  • badwords clearall: clears all bad words.

Settings tokens

  • badwordson: "true" if plugin is enabled, "false" if disabled.
  • badwords: list of bad words, separated by "˜"'s.
  • badwordsanim: name of the punishment animation.
  • penance: penance phrase.

Subsystems

This plugin provides no API to other plugins.

Clone this wiki locally