GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - modmail-dev/modmail-docs

BranchesTags
Open more actions menu

Latest commit

 

History

189 Commits
189 Commits

Folders and files

NameName
Last commit message
Last commit date
.gitbook/assets
.gitbook/assets
 
 
choose-host
choose-host
 
 
config-references
config-references
 
 
faq
faq
 
 
installation
installation
 
 
old-docs
old-docs
 
 
usage-guide
usage-guide
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
SUMMARY.md
SUMMARY.md
 
 
updating.md
updating.md
 
 

Repository files navigation

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

Introduction

Modmail is a self-hosted Discord bot for your server. It works 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 BuyMeACoffee, cool benefits included!

What is Modmail used for?

When a member sends a direct message to Modmail, the bot will create a channel (we call it a "thread") into a designated category. All further DM messages will automatically relay to that channel, then any available staff can respond within the channel. Compared to ticketing bots, Modmail allows easier and more organised discussions among staff.

An example of a Modmail thread.

Our Logviewer will save the threads so your staff can view previous threads through their corresponding log link. Here is an example.

Features

Highly customisable

  • Changeable bot status, prefix, category, log channel, etc.
  • Versatile command permission system.
  • Interface elements (color, responses, reactions, etc.).
  • Snippets and command aliases.
  • Minimum durations for account age and time in server before allowed to contact Modmail.
  • Plugin support for extending functionality.
  • Custom thread creation messages and thread naming formats.
  • Configurable auto-close, inactivity, and notification settings.

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.
  • Discord authentication-protected logs (Patreon/BMAC-only feature).
  • See past logs of a user with ?logs.
  • Searchable by text queries using ?logs search.

Robust implementation

  • Ease of installation: you can get your Modmail bot running in under 10 minutes!
  • Schedule tasks in human time, e.g. ?close in 2 hours silently.
  • Editing and deleting messages are synced.
  • Support for images, files, stickers, and other attachments.
  • Internal notes and moderator-only discussions.
  • Paginated commands interfaces via buttons.
  • Multi-user conversations and private thread management tools.

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

Installation

Visit our installation page for detailed instructions on setting up Modmail for your server.

Supporting the project

You have various options to help the project. Giving this repository a star is greatly appreciated. You can also help people that have trouble setting up Modmail at our Discord server.

Contributing

Support Modmail with your contributions! Whether it be improvements to the documentation or new functionality, please feel free to make the change. Check out our contributing guidelines before you get started.

Next Steps

  • Read about installing Modmail.
  • Become familiar with Modmail commands and functionalities.

{% hint style="info" %} Throughout this documentation when we're referring to bot commands, we will assume the prefix of the bot to be ? and will display them like in this example: ?help.

Optional arguments will be enclosed in square brackets:
Example: ?close [time] [reason] [silently]

Required arguments will be enclosed in angle brackets:
Example: ?contact <user> {% endhint %}

About

No description, website, or topics provided.

Resources

Readme
GPL-3.0 license
Activity
Custom properties

Stars

4 stars

Watchers

1 watching

Forks

14 forks
Report repository

Releases

Packages

Used by

Contributors

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.