|
1 | 1 | <div align="center">
|
2 |
| - <img src='https://i.imgur.com/o558Qnq.png' align='center'> |
3 |
| - <br> |
4 |
| - <strong><i>A simple and functional Modmail bot for Discord.</i></strong> |
5 |
| - <br> |
6 |
| - <br> |
7 |
| - |
8 |
| - |
9 |
| -<a href="https://heroku.com/deploy?template=https://github.com/kyb3r/modmail"> |
10 |
| - <img src="https://img.shields.io/badge/deploy_to-heroku-997FBC.svg?style=for-the-badge" /> |
11 |
| -</a> |
12 |
| - |
13 |
| - |
14 |
| -<a href="https://discord.gg/j5e9p8w"> |
15 |
| - <img src="https://img.shields.io/discord/515071617815019520.svg?style=for-the-badge&colorB=7289DA" alt="Support" /> |
16 |
| -</a> |
17 |
| - |
18 |
| - |
19 |
| - |
20 |
| -<a href="https://github.com/kyb3r/modmail/"> |
21 |
| - <img src="https://api.modmail.tk/badges/instances.svg" alt="Bot instances" /> |
22 |
| -</a> |
23 |
| - |
| 2 | + <img src="https://i.imgur.com/o558Qnq.png" align="center"> |
| 3 | + <br> |
| 4 | + <strong><i>A simple and functional Modmail bot for Discord.</i></strong> |
| 5 | + <br> |
| 6 | + <br> |
| 7 | + |
| 8 | + <a href="https://heroku.com/deploy?template=https://github.com/kyb3r/modmail"> |
| 9 | + <img src="https://img.shields.io/badge/deploy_to-heroku-997FBC.svg?style=for-the-badge"> |
| 10 | + </a> |
| 11 | + |
| 12 | + <a href="https://discord.gg/j5e9p8w"> |
| 13 | + <img src="https://img.shields.io/discord/515071617815019520.svg?style=for-the-badge&colorB=7289DA" alt="Support"> |
| 14 | + </a> |
| 15 | + |
| 16 | + <a href="https://github.com/kyb3r/modmail/"> |
| 17 | + <img src="https://api.modmail.tk/badges/instances.svg" alt="Bot instances"> |
| 18 | + </a> |
| 19 | + |
| 20 | + <a href="https://patreon.com/kyber"> |
| 21 | + <img src="https://img.shields.io/badge/patreon-donate-orange.svg?style=for-the-badge" alt="Python 3.7"> |
| 22 | + </a> |
| 23 | + |
| 24 | + <a href="https://github.com/kyb3r/modmail/blob/master/LICENSE"> |
| 25 | + <img src="https://img.shields.io/badge/license-mit-e74c3c.svg?style=for-the-badge" alt="MIT License"> |
| 26 | + </a> |
| 27 | +</div> |
24 | 28 |
|
25 |
| -<a href="https://patreon.com/kyber"> |
26 |
| - <img src="https://img.shields.io/badge/patreon-donate-orange.svg?style=for-the-badge" alt="Python 3.7" /> |
27 |
| -</a> |
| 29 | +--- |
28 | 30 |
|
| 31 | +## How Does Modmail Work? |
29 | 32 |
|
30 |
| -<a href="https://github.com/kyb3r/modmail/blob/master/LICENSE"> |
31 |
| - <img src="https://img.shields.io/badge/license-mit-e74c3c.svg?style=for-the-badge" alt="MIT License" /> |
32 |
| -</a> |
| 33 | +<img src="https://i.imgur.com/GGukNDs.png" align="right" height="350"> |
33 | 34 |
|
34 |
| -</div> |
35 |
| -<br> |
| 35 | +When a user sends a direct message to the bot, a channel is created within an isolated category. This channel is where messages will be relayed. To reply to the message, simply use the command `?reply` in the channel. A full list of commands can be found in the [wiki](https://github.com/kyb3r/modmail/wiki) or by using the `?help` command. |
36 | 36 |
|
37 |
| -## How does it work? |
| 37 | +## Installation |
38 | 38 |
|
| 39 | +Currently, the easiest and fastest way to set up the bot is by using Heroku, which is a service that offers a free plan for hosting applications. If you choose to install the bot using Heroku, you will not need to download anything. The [**installation guide**](https://github.com/kyb3r/modmail/wiki/Installation) will guide you through the entire installation process. If you run into any problems, join our [Discord server](https://discord.gg/etJNHCQ) for help and support. Even if you don't have any issues, you should come and check out our awesome Discord community! :wink: |
39 | 40 |
|
40 |
| -<img src='https://i.imgur.com/GGukNDs.png' align='right' height=300> |
| 41 | +--- |
41 | 42 |
|
42 |
| -When a user sends a direct message to the bot, a channel is created within an isolated category. This channel is where messages will be relayed. To reply to the message, simply use the command `reply` in the channel. See a full list of commands in the [wiki](https://github.com/kyb3r/modmail/wiki). |
| 43 | +# Notable Features |
43 | 44 |
|
| 45 | +## Customizability |
44 | 46 |
|
45 |
| -## Installation |
| 47 | +Modmail has a range of configuration variables that you can dynamically alter with the `?config` command. You can use them to change the different aspects of the bot, for example, the embed color, responses, reactions, status, etc. Snippets and custom command aliases are also supported. Snippets are shortcuts for predefined messages that you can send. Add or remove snippets with the `?snippets` command. The level of customization is ever growing thanks to our exceptional contributors. |
46 | 48 |
|
47 |
| -Currently the easiest and fastest way to set up the bot is using Heroku which is a service that offers a free plan for hosting applications. If you choose to install the bot using Heroku, you will not need to download anything. Read the **[installation guide](https://github.com/kyb3r/modmail/wiki/Installation)**. If you ran into any problems, join our [discord server](https://discord.gg/etJNHCQ) for help and support. Even if you don't have any issues, you should come and check out our awesome Discord community! :wink: |
| 49 | +## Linked Messages |
48 | 50 |
|
49 |
| -## Notable Features |
| 51 | +<img src="https://i.imgur.com/6L9aaNw.png" align="right" height="350"> |
50 | 52 |
|
| 53 | +Have you sent something with the `?reply` command by accident? Don't fret, you can delete your original message, and the bot will automatically delete the corresponding message sent to the recipient of the thread! You can also use the `?edit` command to edit a message you sent. |
51 | 54 |
|
52 |
| -### Customizability |
53 |
| -There is a range of config variables you can dynamically change with the `config` command to change the appearance of the bot. For example embed color, responses, reactions, status etc. Snippets and custom command aliases are also supported, snippets are shortcuts for predefined messages that you can send. Add and remove snippets with the `snippets` command. The list of things you can change is ever growing thanks to the community for code contributions. |
| 55 | +## Thread Logs |
54 | 56 |
|
55 |
| -### Linked Messages |
56 |
| -<img src='https://i.imgur.com/6L9aaNw.png' height=300 align='right'></img> |
| 57 | +Thread conversations are automatically logged with a generated viewable website of the complete thread. Logs are rendered with styled HTML and presented in an aesthetically pleasing way—it blends seamlessly with the mobile version of Discord. An example of a logged conversation: https://logs.modmail.tk/02032d65a6f3 |
57 | 58 |
|
58 |
| -Did you accidentally send something you didn't mean to with the `reply` command? Don't fret, if you delete the original message on your side, this bot automatically deletes the corresponding message that was sent to the recipient of the thread! This also works when you use the `edit` command to edit a message you have sent. |
| 59 | +## Automatic Updates |
59 | 60 |
|
60 |
| -### Thread Logs |
| 61 | +The bot checks for new updates every hour and will automatically update to the newest version. Modmail is under active development, which means that you can always look forward to new and useful features! To disable this functionality, for example, when you customized your fork, you can do so by adding a `disable_autoupdates` config variable and set it to `yes` or `true`. |
61 | 62 |
|
62 |
| -Thread conversations are automatically logged and a log link is provided with each thread. Logs are rendered with HTML and are presented in an aesthetically pleasing way, exactly like on discord, this especially integrates seamlessly with the mobile version of discord. Here's a link to an [example](https://logs.modmail.tk/02032d65a6f3). |
| 63 | +--- |
63 | 64 |
|
64 |
| -### Automatic Updates |
65 |
| -The bot checks for new updates every hour and automatically updates to a newer version if found. This bot is under active development so you can always look forward to new, useful features! If you do not want this functionality, for example, if you want to make changes to your fork, you can do so by adding a `disable_autoupdates` config variable. |
| 65 | +# Contributing |
66 | 66 |
|
67 |
| -## Contributing |
68 |
| -This project is licenced under MIT. If you have ideas for commands create an issue or pull request. Contributions are always welcome, whether it be documentation improvements or new functionality, please feel free to create a pull request. |
| 67 | +This project is licenced under MIT. If you have any new ideas, create an issue or a pull request. Contributions to Modmail are always welcome, whether it be improvements to the documentation or new functionality, please feel free make the change. |
69 | 68 |
|
70 | 69 | If you use Modmail and love it, consider supporting me on **[Patreon](https://www.patreon.com/kyber)** :heart:
|
0 commit comments