hellnation-anti-spam-bones v2.0.0

discord-anti-spam.js

A simple module with quick setup and different options to implement Anti-Spam system in your bot.

DISCLAMER: You can only setup 1 set of configuration per client. (That means that you can't configure settings for each server for now. You can only modify in which guild checker is run and in which checker is not run.)

Installation

To install this module type in your console command below:

npm i discord-anti-spam

Example

Example of a basic bot handles spam messages using this module.

const Discord = require('discord.js');
const antispam = require('discord-anti-spam'); // Requiring this module.
const client = new Discord.Client();

client.on('ready', () => {
  // Module Configuration Constructor
   antispam(client, {
        warnBuffer: 3, // Maximum ammount of messages allowed to send in the interval time before getting warned.
        maxBuffer: 5, // Maximum amount of messages allowed to send in the interval time before getting banned.
        interval: 2000, // Amount of time in ms users can send the maxim amount of messages(maxBuffer) before getting banned. 
        warningMessage: "please stop spamming!", // Message users receive when warned. (message starts with '@User, ' so you only need to input continue of it.) 
        banMessage: "has been hit by ban hammer for spamming!", // Message sent in chat when user is banned. (message starts with '@User, ' so you only need to input continue of it.) 
        maxDuplicatesWarning: 7,// Maximum amount of duplicate messages a user can send in a timespan before getting warned.
        maxDuplicatesBan: 10, // Maximum amount of duplicate messages a user can send in a timespan before getting banned.
        deleteMessagesAfterBanForPastDays: 7, // Deletes the message history of the banned user in x days.
        exemptRoles: ["Moderator"], // Name of roles (case sensitive) that are exempt from spam filter.
        exemptUsers: ["MrAugu#9016"] // The Discord tags of the users (e.g: MrAugu#9016) (case sensitive) that are exempt from spam filter.
      });
      
  // Rest of your code
});

client.on('message', msg => {
  client.emit('checkMessage', msg); // This runs the filter on any message bot receives in any guilds.
  
  // Rest of your code
}

client.login('token');

The code above will allow to send maximum 3 messages in interval of the time, if more user gets warned. It will allow maximum 5 messages in an interval of 2000 Miliseconds (2 Seconds in Miliseconds), if more bot attempts to ban the user. The users will we warned with message @User, please stop spamming!. If user gets banned others will be notified with message @User has been hit by ban hammer in for spamming!. Maximum number duplicated messages before user gets warned is 7. Maximum number duplicated messages before bot attempts to ban user is 10. If user gets banned, the bot will delete an equivalent of 7 days of messages by that user. The bot will ignore any people with a role named Moderator and bot will ignore people named MrAugu#9016.

Documentation

antispam(<Client>);

This will configure module to run on its default configuration. <Client> - Variable that defines new Discord.Client() antispam - Variable that defines require('discord-anti-spam')

client.emit('checkMessage', <Message>)

<Message> - Variable that defines the message itself. (client.on('message', async (msg) =>{}) in this situation msg is the variable.) This will basically send your message to module. In fact is REQUIERED for module to run.

antispam(client, {
        warnBuffer: 3,
        maxBuffer: 5,
        interval: 2000,
        warningMessage: "",
        banMessage: "",
        maxDuplicatesWarning: 7,
        maxDuplicatesBan: 10,
        deleteMessagesAfterBanForPastDays: 7,
        exemptRoles: [],
        exemptUsers: []
      });

antispam - Variable that defines require('discord-anti-spam') <Client> - Requiered, Discord.Client warnBuffer - Optional, Type: Integer maxBuffer - Optional, Type: Integer interval - Optional, Type: Integer warningMessage - Optonal, Type: String, Minimum 5 Characters banMessage - Optional, Type: String, Minimum 5 Characters maxDuplicatesWarning - Optional, Type: Integer maxDuplicatesBan - Optional, Type: Integer deleteMessagesAfterBanForPastDays - Optional, Type: Integer exemptRoles - Optional, Type: Array exemptUsers- Optional, Type: Array NOTE: The module will throw errors for assigning incorect types to configuration values. That's pretty much all. <3 If you have any issues, bugs or trouble setting the module up. feel free to open an issue on Github