https://github.com/jakejmattson/modmail

A Discord report management bot.
https://github.com/jakejmattson/modmail

discord discord-bot discordkt

Last synced: 8 months ago
JSON representation

A Discord report management bot.

• Host: GitHub
• URL: https://github.com/jakejmattson/modmail
• Owner: JakeJMattson
• License: mit
• Created: 2020-07-26T19:58:03.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-04T17:03:42.000Z (almost 2 years ago)
• Last Synced: 2024-09-05T23:42:57.855Z (almost 2 years ago)
• Topics: discord, discord-bot, discordkt
• Language: Kotlin
• Homepage:
• Size: 787 KB
• Stars: 18
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          


   

   

   

   

   

   

   


   

   

   



# ModMail

ModMail is a Discord bot designed to provide a communication system between server staff and other members.

## Reports

Reports are private text channels that allow the entire staff team to communicate with a single member.

![Reports](https://i.imgur.com/7vgwc9E.png)

### Creating Reports

Reports will be opened automatically whenever a user messages the bot.

The `/Open` command can be used to open a report manually, or `/Detain` if you want to mute them as well.

### Using a Report

Once a report is opened, anyone with access to this private channel can talk with the user through the bot.

The user only needs to talk with the bot like a normal DM.

#### Closing a Report

##### From Discord

* Delete the channel - ModMail will detect the event and close the report for you.

##### Using Commands

* `/Close` - This has the same effect as deleting the channel.

* `/Archive` - Transcribes the report to text, archives it, then closes the report.

## Setup

Refer to the [setup](setup.md) instructions.

## Commands

To see available commands, use `Help` or read the [commands](commands.md) documentation.