2017-02-10 00:19:14 -05:00
# Modmail for Discord
A bot for [Discord ](https://discordapp.com/ ) that allows users to DM the bot to contact the server's entire mod team.
These DMs get relayed to a modmail server where each user gets their own channel, or "thread".
Moderators and admins can then reply to these threads, and these responses are relayed back to the original user as a DM.
Inspired by Reddit's modmail system.
## Setup
1. Install Node.js 6 or higher
2. Clone or download this repository
3. Create a Discord server to be used as the modmail inbox
4. Copy `config.example.json` to `config.json` and fill in the values
2017-02-10 00:47:10 -05:00
5. Install dependencies: `npm install`
2017-05-01 05:14:28 -04:00
6. Add bot to servers, and make sure to give it proper permissions on the mail server.
7. Run the bot: `node src/index.js`
2017-02-10 00:19:14 -05:00
## Commands
##### Anywhere on the modmail inbox server
`!logs <user>` Lists previous modmail logs with the specified user
`!block <user>` Blocks the specified user from using modmail
`!unblock <user>` Unblocks the specified user from using modmail
##### Inside a modmail thread
`!reply <text>` Sends a reply to the user in the format "(Role) User: text" (alias `!r` )
2017-05-01 05:14:28 -04:00
`!anonreply <text>` Sends an anonymous reply to the user in the format "Role: text" (alias !ar)
2017-02-10 00:19:14 -05:00
`!close` Closes the modmail thread and saves a log of it
`!logs` Lists previous modmail logs with this user
`!block` Blocks the user from using modmail
`!unblock` Unblocks the user from using modmail
2017-05-01 05:14:28 -04:00
To automatically reply without using !reply or !r, enable `alwaysReply` in the config. `alwaysReplyAnon` sets whether to reply anonymously. If you do not wish to reply, it will ignore any message starting in the prefix (which defaults to !), such as !note
