Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/modmail-dev/Modmail

A Discord bot that functions as a shared inbox between staff and members, similar to Reddit's Modmail.
https://github.com/modmail-dev/Modmail

bot discord discord-api discord-bot discord-modmail discord-py modmail python python3

Last synced: about 2 months ago
JSON representation

A Discord bot that functions as a shared inbox between staff and members, similar to Reddit's Modmail.

Host: GitHub
URL: https://github.com/modmail-dev/Modmail
Owner: modmail-dev
License: agpl-3.0
Created: 2017-10-08T06:24:54.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2024-10-27T14:02:56.000Z (about 2 months ago)
Last Synced: 2024-10-29T15:35:09.151Z (about 2 months ago)
Topics: bot, discord, discord-api, discord-bot, discord-modmail, discord-py, modmail, python, python3
Language: Python
Homepage: https://docs.modmail.dev
Size: 6.94 MB
Stars: 1,580
Watchers: 57
Forks: 4,586
Open Issues: 48
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-discord - modmail - A feature rich discord Modmail bot. (Bots / Self Host-able Bots)
starred - modmail-dev/Modmail - A Discord bot that functions as a shared inbox between staff and members, similar to Reddit's Modmail. (Python)

README

A feature-rich Modmail bot for Discord.

## What is Modmail?

Modmail is similar to Reddit's Modmail, both in functionality and purpose. It serves as a shared inbox for server staff to communicate with their users in a seamless way.

This bot is free for everyone and always will be. If you like this project and would like to show your appreciation, you can support us on **[Patreon](https://www.patreon.com/kyber)**, cool benefits included!

For up-to-date setup instructions, please visit our [**documentation**](https://docs.modmail.dev/installation) page.

## How does it work?

When a member sends a direct message to the bot, Modmail will create a channel or "thread" into a designated category. All further DM messages will automatically relay to that channel; any available staff can respond within the channel.

Our Logviewer will save the threads so you can view previous threads through their corresponding log link. ~~Here is an [**example**](https://logs.modmail.dev/example)~~ (demo not available at the moment).

## Features

* **Highly Customisable:**
* Bot activity, prefix, category, log channel, etc.
* Command permission system.
* Interface elements (color, responses, reactions, etc.).
* Snippets and *command aliases*.
* Minimum duration for accounts to be created before allowed to contact Modmail (`account_age`).
* Minimum length for members to be in the guild before allowed to contact Modmail (`guild_age`).

* **Advanced Logging Functionality:**
* When you close a thread, Modmail will generate a log link and post it to your log channel.
* Native Discord dark-mode feel.
* Markdown/formatting support.
* Login via Discord to protect your logs ([premium Patreon feature](https://patreon.com/kyber)).
* See past logs of a user with `?logs`.
* Searchable by text queries using `?logs search`.

* **Robust implementation:**
* Schedule tasks in human time, e.g. `?close in 2 hours silently`.
* Editing and deleting messages are synced.
* Support for the diverse range of message contents (multiple images, files).
* Paginated commands interfaces via reactions.

This list is ever-growing thanks to active development and our exceptional contributors. See a full list of documented commands by using the `?help` command.

## Installation

There are a number of options for hosting your very own dedicated Modmail bot.

Visit our [**documentation**](https://docs.modmail.dev/installation) page for detailed guidance on how to deploy your Modmail bot.

### Patreon Hosting

If you don't want the trouble of renting and configuring your server to host Modmail, we got a solution for you! We offer hosting and maintenance of your own, private Modmail bot (including a Logviewer) through [**Patreon**](https://patreon.com/kyber).

## FAQ

**Q: Where can I find the Modmail bot invite link?**

**A:** Unfortunately, due to how this bot functions, it cannot be invited. The lack of an invite link is to ensure an individuality to your server and grant you full control over your bot and data. Nonetheless, you can quickly obtain a free copy of Modmail for your server by following our [**documentation**](https://docs.modmail.dev/installation) steps or subscribe to [**Patreon**](https://patreon.com/kyber).

**Q: Where can I find out more info about Modmail?**

**A:** You can find more info about Modmail on our [**documentation**](https://docs.modmail.dev) page. If you run into any problems, join our [Modmail Discord Server](https://discord.gg/cnUpwrnpYb) for help and support.

## Plugins

Modmail supports the use of third-party plugins to extend or add functionalities to the bot.
Plugins allow niche features as well as anything else outside of the scope of the core functionality of Modmail.

You can find a list of third-party plugins using the `?plugins registry` command or visit the [Unofficial List of Plugins](https://github.com/modmail-dev/modmail/wiki/Unofficial-List-of-Plugins) for a list of plugins contributed by the community.

To develop your own, check out the [plugins documentation](https://github.com/modmail-dev/modmail/wiki/Plugins).

Plugins requests and support are available in our [Modmail Support Server](https://discord.gg/cnUpwrnpYb).

## Sponsors

Special thanks to our sponsors for supporting the project.

SirReddit:

Prime Servers Inc:

Real Madrid:

Advertise Your Server:

Help Us • Help Other's:

Discord Advice Center:

Become a sponsor on [Patreon](https://patreon.com/kyber).

## Contributing

Contributions to Modmail are always welcome, whether it be improvements to the documentation or new functionality, please feel free to make the change. Check out our [contributing guidelines](https://github.com/modmail-dev/modmail/blob/master/.github/CONTRIBUTING.md) before you get started.

If you like this project and would like to show your appreciation, support us on **[Patreon](https://www.patreon.com/kyber)**!

## Beta Testing

Our [development](https://github.com/modmail-dev/modmail/tree/development) branch is where most of our features are tested before public release. Be warned that there could be bugs in various commands so keep it away from any large servers you manage.

If you wish to test the new features and play around with them, feel free to join our [Public Test Server](https://discord.gg/v5hTjKC). Bugs can be raised within that server or in our Github issues (state that you are using the development branch though).