Go to file

baptiste0928 4544ac5db8 Add custom emoji instructions for reactOnSeenEmoji (#543 )		2021-01-28 14:42:16 +02:00
.github	Create dependabot.yml	2020-08-16 19:12:22 +03:00
attachments	Add attachment rehosting; forward attachments in replies	2016-12-16 09:26:05 +02:00
db	Move migration files within src	2020-09-23 02:34:40 +03:00
docs	Add custom emoji instructions for reactOnSeenEmoji (#543 )	2021-01-28 14:42:16 +02:00
logs	Add log saving and serving	2016-12-06 02:29:55 +02:00
src	Add option: useGitForGitHubPlugins	2021-01-07 21:13:45 +02:00
.editorconfig	Switch from TOML to INI. New documentation. Add start.bat file for Windows.	2019-12-03 01:51:11 +02:00
.eslintrc	Fix crash when a user sends an attachment	2020-08-17 11:26:06 +03:00
.gitignore	Revert some accidental changes from #319	2020-01-19 21:33:46 +02:00
.npmrc	Hide extra error info by npm to make error messages clearer to the user	2018-03-11 21:31:23 +02:00
.nvmrc	Update node-sqlite3 to v5. Update Node.js version requirements accordingly.	2020-07-09 04:05:28 +03:00
CHANGELOG.md	Add an example for '-c' usage in CHANGELOG	2021-01-07 21:25:42 +02:00
LICENSE.md	Add MIT license	2017-03-01 09:58:53 +02:00
README.md	Update README.md (added more emojis to 'Getting Started') (#513 )	2020-12-13 04:40:06 +02:00
config.example.ini	Add some common settings to config.example.ini	2020-11-22 13:25:05 +02:00
knexfile.js	Fix inconsistency between knexfile and runtime knex config	2020-08-13 23:55:29 +03:00
modmailbot-pm2.json	Update modmailbot-pm2.json (#478 )	2020-11-01 20:39:39 +02:00
package-lock.json	3.3.0	2021-01-07 21:18:11 +02:00
package.json	3.3.0	2021-01-07 21:18:11 +02:00
start.bat	Switch from TOML to INI. New documentation. Add start.bat file for Windows.	2019-12-03 01:51:11 +02:00

README.md

Modmail for Discord

Modmail Bot is a bot for Discord that allows users to DM the bot to contact the server's moderators/staff without messaging them individually or pinging them publically on the server. These DMs get relayed to modmail threads, channels where staff members can reply to and talk with the user. To the user, the entire process happens in DMs with the bot.

Inspired by Reddit's modmail system.

⚠ Note on updating to v3.0.0: If you're currently using a very old version of the bot, from before February 2018, you'll first need to update to v2.30.1 and run the bot once before updating to v3.0.0.

Always take a backup of your db/data.sqlite file before updating the bot.

Getting started

Support server

If you need help with setting up the bot or would like to discuss other things related to it, join the support server on Discord here:

👉 Join support server