Giter Club home page Giter Club logo

modmail.js's Introduction

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

Install

npm i modmail.js@latest

Example Usage

const modmail = require('modmail.js') 

modmail.on({ 
  token: 'BOT_TOKEN', 
  inbox: 'INBOX_CHANNEL_ID', 
  prefix: 'BOT_PREFIX', 
  message: '@mentions/messages', 
  inline: true, // inlineReply
  
  })
  .then(r=>{
  console.log(r)
  }).catch(err => {
  console.log(err)
  })

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 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.

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

modmail.js's People

Contributors

leecheeyong avatar

Stargazers

Pabliea avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.