m (added <br> lines to force formatting) |
|||
| (3 intermediate revisions by one other user not shown) | |||
| Line 7: | Line 7: | ||
==Description== | ==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. | + | <span style="color: lightblue;">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.</span> |
| − | + | <b>Note:</b> If you have timestamps active, either through the default MQ settings, or with MQ2Timestamp loaded, the filtering will fail. | |
| − | + | ==Configuration== | |
| − | |||
| − | |||
| − | |||
| − | == | + | <span style="color: lightblue;">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.</span> |
| + | |||
| + | <span style="color: lightblue;">Default settings for new characters added to the plugin INI file are read from [CF_Settings] and [CF_Filters]. Otherwise, they are read from [CF_Settings_Server_Char] and [CF_Filters_Server_Char].</span> | ||
| − | + | <span style="color: lightblue;">Example of a character named Bubba on the Povar server:</span><BR/> | |
| + | <span style="color: green;">[CF_Settings_Povar_Bubba]</span><BR/> | ||
| + | <span style="color: green;">[CF_Filters_Povar_Bubba]</span><BR/> | ||
===Sample Configuration=== | ===Sample Configuration=== | ||
| − | MQ2ChatFilter.ini | + | <span style="color: yellow;">MQ2ChatFilter.ini</span> |
| − | <pre>[ | + | <span class="highlight2"><pre>[CF_Settings] |
DefaultState=on | DefaultState=on | ||
| + | SpamFilter=on | ||
| − | [ | + | [CF_Filters] |
Filter1=www.gm963.com | Filter1=www.gm963.com | ||
Filter2=www.gmworker.com | Filter2=www.gmworker.com | ||
| − | </pre> | + | Filter3=surrounded by the aura of the muse |
| + | </pre></span> | ||
===Configuration Explanation=== | ===Configuration Explanation=== | ||
| Line 37: | Line 40: | ||
===Command Syntax=== | ===Command Syntax=== | ||
| − | <span class="highlight2">/chatfilter [help | on | off | load | save | add | del | clear | default | list]</span> | + | <span class="highlight2">/chatfilter [help | on | off | load | save | add | del | clear | default | list | spam | debug]</span> |
* <span class="highlight2">on</span>: Turns chat filtering on. | * <span class="highlight2">on</span>: Turns chat filtering on. | ||
| Line 48: | Line 51: | ||
* <span class="highlight2">default</span>: Toggles default status at plugin load (the .ini will be updated with this value). | * <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. | * <span class="highlight2">list</span>: Lists current filters. | ||
| + | * <span class="highlight2">spam</span>: Toggles automatic filtering of (SPAM) lines. | ||
| + | * <span class="highlight2">debug</span>: Toggles some debug messages to help with troubeshooting. | ||
==Availability== | ==Availability== | ||
| − | MQ2ChatFilter is available as part of the MMOBugs plugin distribution. | + | <span style="color: red;">MQ2ChatFilter is available as part of the MMOBugs plugin distribution for all release types (Live, Test, Emu).</span><BR/> |
Latest revision as of 13:50, 6 January 2023
| Plugin Info | |
|---|---|
| Name | MQ2ChatFilter |
| Version | 1.14 |
| Author | htw |
| Uses INI File | Yes |
Contents
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.
Note: If you have timestamps active, either through the default MQ settings, or with MQ2Timestamp loaded, the filtering will fail.
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.
Default settings for new characters added to the plugin INI file are read from [CF_Settings] and [CF_Filters]. Otherwise, they are read from [CF_Settings_Server_Char] and [CF_Filters_Server_Char].
Example of a character named Bubba on the Povar server:
[CF_Settings_Povar_Bubba]
[CF_Filters_Povar_Bubba]
Sample Configuration
MQ2ChatFilter.ini
[CF_Settings] DefaultState=on SpamFilter=on [CF_Filters] Filter1=www.gm963.com Filter2=www.gmworker.com Filter3=surrounded by the aura of the muse
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 | spam | debug]
- 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.
- spam: Toggles automatic filtering of (SPAM) lines.
- debug: Toggles some debug messages to help with troubeshooting.
Availability
MQ2ChatFilter is available as part of the MMOBugs plugin distribution for all release types (Live, Test, Emu).