discord-moderator

Welcome

Welcome! This 'discord-moderator' module!
This is a simple module for adding moderation to Discord bot.

Installation

Please note: Node.js 14.0.0 or newer is required.
All types in brackets mean the type of what the method or event returns.

Install discord-moderator

$ npm install discord-moderator

Features

• Simple & easy to use 👍
• Beginner friendly 😄
• Minimalistic option constructor 🔧
• TypeScript Support 🔑
• Flexible and customizable 🛠️
• 100% Promise-based ⚙️

Module Managers

• 'BlacklistManager' - Manager that enables Blacklist System.
• 'MuteManager' - Manager that enables Mute System.
• 'PunishmentManager' - Manager that enables Blacklist System.
• 'RolesManager' - Manager that enables Roles System.
• 'UtilsManager' - Manager that includes some utils for other managers.
• 'WarnManager' - Manager that enables Warn System.

Module Constructor Options

• 'options.muteManager' - Property responsible for the status of the muting manager.

• 'options.warnManager' - Property responsible for the status of the warning manager.

• 'options.blacklistManager' - Property responsible for the status of the blacklist manager.

• 'options.muteConfig.tableName' - Property responsible for the name of the table for the mute manager.

• 'options.muteConfig.checkCountdown' - Property responsible for the checking interval of all mutes.

• 'options.warnConfig.tableName' - Property responsible for the name of the table for the warn manager.

• 'options.warnConfig.maxWarns' - Property responsible for the maximum number of warnings.

• 'options.warnConfig.punishment' - Property responsible for the method of punishing the user. Available: tempmute, mute, kick, ban.

• 'options.warnConfig.muteTime' - Property responsible for the mute time for the tempmute punishment method.

• 'options.blacklistConfig.tableName' - Property responsible for the name of the table for the blacklist manager.

• 'options.blacklistConfig.punishment' - Property responsible for the method of punishing the user. Available: kick, ban.

Quick Initialization Example

const Discord = require('discord.js');

const client = new Discord.Client();
const Moderator = require('discord-moderator');
const moderator = new Moderator(client);

client.on('ready', () => {
  console.log('Bot started!');
})

client.login('YOUR_BOT_TOKEN_HERE');

Examples

Click here to see JavaScript examples.

Useful Links

• Module Developer: xyligan
• Developer Discord: ♡ xүℓ[ι]gαη4εg ♡#9457
• Documentation: Click
• NPM: Click
• GitHub: Click
• Examples: Click
• Support Server - Click

Thanks for using Discord Moderator ♥