Code Monkey home page Code Monkey logo

modmail's Introduction

ModMail

ModMail is a Discord bot which main purpose is to provide users-to-moderators private communication. This bot needs to be hosted, as it is meant for a single Discord server.

Setup

Setting up this bot is pretty easy, just follow the steps below.

  1. Fork and clone this repo.
  2. Create a Discord application and get the bot token.
  3. Create a file called .env in the main directory. Add the following:
    BOT_TOKEN=YOU_TOKEN_GOES_HERE
    HOST=YOUR_HOST(READ_BELOW)
    URL=YOUR_REPLIT_URL

    The host option is only required if Repl.it is going to be used. If so, the value must be REPLIT, if not, feel free to remove that line. If you are using Repl.it, provide the URL too (should look something like this: https://ProjectName--YourUsername.repl.co). Paste that same URL here and click "ADD".

  4. Run npm run setup.
  5. Fill the src/config.ts file.
  6. Run npm run start to start your bot. If you want to use any node runtime such as PM2, run npm run build and then start the process as you would normally do (file prod/index.js).

How does it work?

  • Someone DMs your bot and a thread will be opened inside the specified category.
  • Moderators get notified and start chatting with them via the bot.

Commands

reply {content} - Thread Only
close - Thread Only
set

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.