Difference between revisions of "MQ2ChatFilter" - MMOBugs Wiki

Line 1: Line 1:
 
{{Pluginbox
 
{{Pluginbox
 
|author=[[User:htw|htw]]
 
|author=[[User:htw|htw]]
 +
|version=1.14
 +
|usesini=Yes
 
}}
 
}}
  
[[Category: Incomplete Plugin Pages]]
+
==Description==
{{stub}}
+
 
 +
This plugin allows you to filter out lines that would go to your chat windows.  Any lines that are filtered out, will not be shown in game.  Good for spammers or other types of annoyances.
 +
 
 +
==Configuration==
 +
 
 +
The plugin is configured via an INI file.  Entries are a substring search, and are NOT case sensitive.  Using /chatfilter without parameters will show command syntax.
 +
 
 +
===Sample Configuration===
 +
MQ2ChatFilter.ini
 +
<pre>[Settings]
 +
DefaultState=on
 +
 
 +
[Filters]
 +
Filter1=www.gm963.com
 +
Filter2=www.gmworker.com
 +
</pre>
 +
 
 +
===Configuration Explanation===
 +
 
 +
* <span class="highlight2">DefaultState</span>: Controls the state of the plugin when you first log into game.  If DefaultState=on, then filtering is enabled as soon as the plugin is loaded.
 +
* <span class="highlight2">filter#</span>: Where # = 1, 2, etc.  See the example above.  I.e., Filter1=www.gm963.com would filter out any chat lines with www.gm963.com in it, before you ever saw the chat line in game.
 +
 
 +
===Command Syntax===
 +
 
 +
<span class="highlight2">/chatfilter [help | on | off | load | save | add | del | clear | default | list]</span>
 +
 
 +
* <span class="highlight2">on</span>: Turns chat filtering on.
 +
* <span class="highlight2">off</span>: Turns chat filtering off.
 +
* <span class="highlight2">load</span>: Loads settings and filters from .ini file (any unsaved additions will be lost!).
 +
* <span class="highlight2">save</span>: Updates .ini file to match current options and filters that are active.
 +
* <span class="highlight2">add</span>: Add a new filter (ex: /chatfilter add "wtb plat" ).
 +
* <span class="highlight2">del</span>: Delete a filter (ex: /chatfilter del 15  ).  Deletes filter #15.
 +
* <span class="highlight2">clear</span>: Clears all filters.
 +
* <span class="highlight2">default</span>: Toggles default status at plugin load (the .ini will be updated with this value).
 +
* <span class="highlight2">list</span>: Lists current filters.
 +
 
 +
==Availability==
 +
 
 +
MQ2ChatFilter is available as part of the MMOBugs plugin distribution.

Revision as of 11:48, 10 November 2008

Plugin Info
Name MQ2ChatFilter
Version 1.14
Author htw
Uses INI File Yes


Description

This plugin allows you to filter out lines that would go to your chat windows. Any lines that are filtered out, will not be shown in game. Good for spammers or other types of annoyances.

Configuration

The plugin is configured via an INI file. Entries are a substring search, and are NOT case sensitive. Using /chatfilter without parameters will show command syntax.

Sample Configuration

MQ2ChatFilter.ini

[Settings]
DefaultState=on

[Filters]
Filter1=www.gm963.com
Filter2=www.gmworker.com

Configuration Explanation

  • DefaultState: Controls the state of the plugin when you first log into game. If DefaultState=on, then filtering is enabled as soon as the plugin is loaded.
  • filter#: Where # = 1, 2, etc. See the example above. I.e., Filter1=www.gm963.com would filter out any chat lines with www.gm963.com in it, before you ever saw the chat line in game.

Command Syntax

/chatfilter [help | on | off | load | save | add | del | clear | default | list]

  • on: Turns chat filtering on.
  • off: Turns chat filtering off.
  • load: Loads settings and filters from .ini file (any unsaved additions will be lost!).
  • save: Updates .ini file to match current options and filters that are active.
  • add: Add a new filter (ex: /chatfilter add "wtb plat" ).
  • del: Delete a filter (ex: /chatfilter del 15 ). Deletes filter #15.
  • clear: Clears all filters.
  • default: Toggles default status at plugin load (the .ini will be updated with this value).
  • list: Lists current filters.

Availability

MQ2ChatFilter is available as part of the MMOBugs plugin distribution.