ModMail Bot

About

Simple way to contact server administration team with ticket organization system

Features

- User direct messages the bot account, bot account sends message to channel specifically assigned to the user.
- Easy to use ticket management system
- Tickets stored in convinient, customizable channel category
- Close any ticket to remove the channel category
- Chat log uploaded after ModMail closed

Example

The screen on the left simulates a user and the screen on the rights simulates an admin.

Issues? Suggestions?

If you are experiencing issues or have a suggestions please submit an issue on GitHub.

Installation

1. Clone the bot from Github

$ git clone https://github.com/Saamstep/modmail.git

2. Navigate to the bot foler via the command line

$ cd modmail/

3. Install node packages

$ npm install --save

  • This may take some time
  • Setup 
    Discord Bot Token

    1. Go to https://discordapp.com/developers
    2. Login with Discord 
    3. Click New Application 
    4. Name your app anything you would like. 
    5. On the left side, click Bot 
    6. Click Add Bot 
    7. Confirm by selecting, Yes, do it! 
    8. Click Copy underneath Click to Reveal Token
    9. You can set a profile picture if you would like for your bot under the Bot tab.

    Config File Setup
  • Setup scripts are in the works to make installation easier! Stay tuned for updates in my Discord server :)
  • Create a config file called config.json in the root folder of the bot (same folder as index.js)

    You can also just create a copy of the example config.json with the command below 

    $ cp example.config.json config.json

  • The Nano text editor is quite useful for quickly editing your config file. You can also use other third party applications.

    To access the Nano editor run the command below

    $ sudo nano config.json

    When you finished editing click CTRL X ---> Y ---> Enter

     View on Github

    How to's

    Get Owner ID

    1. Open Discord
    2. Click User Settings
    3. Click Appearance
    4. Enable Developer Mode
    5. Right click yourself
    6. Click Copy ID

    Get Channel ID

    1. Open Discord
    2. Click User Settings
    3. Click Appearance
    4. Enable Developer Mode
    5. Right click yourself
    6. Click Copy ID

    Get Guild ID

    1. Navigate to the Server Settings of the server for       ModMail
    2. Go to Widget
    3. Copy the Server ID with the Copy button

    Get Invite Link for Bot

    1. Go to https://discordapp.com/developers
    2. Navigate to your applications settings
    3. Under the General Information tab, copy the Client ID
    4. Use the generator below
    5. Paste in your Client ID into the text field and select ModMail from the dropdown.

    Discord Bot Invite Generator

    Website by Samstep | Made with Pingendo