/modmail.js

A Simple Discord Modmail Bot Template

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Modmail.js

NPM version NPM downloads Dependencies

npm installnfo

Table Of Contents

About

Modmail.js is an advance Discord Modmail template.

  • Performant
  • Build-in Plugins
  • Easy To Setup
  • Extendable

Install

npm i modmail.js@latest

Example Usage

const { Modmail, Intents } = require('modmail.js') 

(async () => {
  try{
const modmail = await Modmail({ 
       token: 'BOT_TOKEN', 
       inbox: 'INBOX_CHANNEL_ID', 
       prefix: 'BOT_PREFIX', 
       clientIntents: ['CLIENT_INTENTS'],
       message: '@mentions/messages',   
  });
console.log(modmail)
  }catch(e){
    console.log(e)
  }
})()

Startup

Getting Started With The Modmail Bot

  1. Replace BOT_TOKEN as your discord bot token, INBOX_CHANNEL_ID as a modmail inbox channel's id, CLIENT_INTENTS as Array Of Privileged Intents Flags and BOT_PREFIX as your bot prefix

  2. You're all set ! Now you just have to run the the bot. e.g node index.js, e.g node bot.js.

node.js@v16.6.0 and above is required for this module. Learn More

How to use

  1. Allow private message from server members default:allowed

  2. DM ( Direct Message ) Your Bot And It will react ✅ to your message

  3. Check Your Inbox Channel, See If There's Anything

To Reply A User

  • <PREFIX>reply <USER_ID> <YOUR_MESSAGE> e.g. !reply 123456677544 Hello

Please Read Our Docs To Learn More.

Plugins

Use plugins to improve user experience

Links

License

This project is available as open source under the terms of the Apache License 2.0