Skip to content

jackriccomini/spamfilter-plugin-runelite

Repository files navigation

Spam filter for RuneLite

A naive Bayesian spam filter for RuneLite based on Paul Graham's A Plan for Spam.

Demo image

Reporting spam or ham (training the filter)

The filter is preloaded with a small amount of data. To make it effective against spam messages it hasn't seen before, right click on a spam message in public chat and choose "mark spam". You can do this to repeated spam messages; each time you report an identical message, the filter will consider it and similar messages to be more "spammy".

Demo of marking a message as spam

The opposite of "mark spam" is "mark ham", which tells the filter that a message is not spam. This option is hidden by default and must be enabled in the plugin settings.

Configuration

Filter overheads stops spam messages from appearing above a player's head. This is enabled by default.

Filter type controls how spam messages are handled in the chat log. "Grey messages" (enabled in these screenshots) shows spam messages but greys them out. "Hide messages" is the default option and hides spam messages from the chat log entirely.

Show spam scores (enabled in these screenshots) displays in the chat log how "spammy" the filter thinks each message is. This is shown in magenta and is a number from (0.00) to (1.00). This will show you the effect of marking a message as spam or ham. This is disabled by default.

Threshold controls how aggressive the spam filter is. Its default value is 98%, meaning that messages with a spam score of (0.98) or higher will be considered spam.

Show "mark spam" right-click option enables the "mark spam" right-click option on public chat messages. This is enabled by default.

Show "mark ham" right-click option enables the "mark ham" right-click option on public chat messages. This is disabled by default.

Rough edges

This plugin was hacked together over the course of a rainy weekend. It works well if you take the time to train the filter. However, be aware:

  • It has limited training data out of the box
  • Its code is unoptimised and may run slowly

About

Spam filter plugin for RuneLite

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5

Languages