Skip to content

Commit 6cc658a

Browse files
committed
Merge from "master"
2 parents af62d84 + c468648 commit 6cc658a

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939

4040
<img src='https://i.imgur.com/GGukNDs.png' align='right' height=300>
4141

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 [below](#features-and-commands).
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).
4343

4444

4545
## Installation
@@ -50,13 +50,25 @@ Currently the easiest and fastest way to set up the bot is using Heroku. If you
5050

5151
Heroku is a container based cloud platform that currently offers a free plan to host web apps. However, these apps have an ephemeral file system and thus cannot store any data on site. We have made Modmail be accessible to anyone while still being feature-rich; it's a community run project that lets anyone get it up and running 24/7 for free. So how does our bot store data? Configs and logs are stored in a [centralized web service](https://modmail.tk) hosted by us. This enables you to get started easily and fast. However, you do also have the option to self-host your data, check the installation guide for more info.
5252

53-
## Features and Commands
54-
The bot comes with a plethora of useful functionality. Take a look at the [list of commands](https://github.com/kyb3r/modmail/wiki/Features-and-commands).
53+
## Notable Features
54+
55+
56+
### Customizability
57+
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.
58+
59+
### Linked Messages
60+
<img src='https://i.imgur.com/eo3CwLm.png' height=300 align='right'></img>
61+
62+
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.
63+
64+
### Thread Logs
65+
66+
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.
5567

5668
### Automatic Updates
5769
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.
5870

5971
## Contributing
6072
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.
6173

62-
If you use Modmail and love it, consider supporting me on [Patreon](https://www.patreon.com/kyber) :heart:
74+
If you use Modmail and love it, consider supporting me on **[Patreon](https://www.patreon.com/kyber)** :heart:

cogs/utility.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ def format_cog_help(self, ctx, cog):
6060

6161
em.add_field(name='Commands', value=fmt)
6262

63-
em.set_footer(text=f'Type "{prefix}command" '
63+
em.set_footer(text=f'Type "{prefix}help command" '
6464
'for more info on a command.')
6565
return em
6666

0 commit comments

Comments
 (0)