Git Product home page Git Product logo

modmail-1's Introduction

ModMail

Welcome to ModMail. ModMail is an open-source ModMail bot that helps Discord Guild Moderators help their community easily and privately!

Information: This bot is written in eris. You'll need to install node.js to run it. This bot not hosted anywhere, you will have to host it yourself. For starter users you can use things like glitch.com.

Getting started

To setup the bot, head over to Discord's developer portal, click new application, then bot, and add a bot account. Copy the token and put it into the token slot of the .env file. To run, ensure you have all the components installed;

npm install eris npm install moment npm install axios

Configure the bot in config.js

    token: 'YOUR BOT TOKEN HERE',
    databaseToken: 'YOUR MONGODB TOKEN HERE', // We use MongoDB to store data! https://www.mongodb.com/

    mainGuild: '', // Main ModMail Guild ID (server)
    logChannel: '', // Channel ID of where you want ModMail Logs
    mailChannel: '', // **Category** ID of where you want ModMail channels to be!
    modRoles: [''],

    status: 'DM me for support!', // This will be the bot's playing status
    color: 0xfcfcfc, // Color of logging embeds!
    prefix: '!', // Bot prefix for commands
    msgPrefix: 'Staff' // The prefix that shows on messages (ex. Staff pink,: Hi!)

A list of all commands can be found here

If you're running into any issues with your current ModMail, ensure that all code is updated. If you still encounter an error, post an issue

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.