Skip to content

Commit 082b7e1

Browse files
authored
Update features section.
1 parent 5020747 commit 082b7e1

File tree

1 file changed

+44
-11
lines changed

1 file changed

+44
-11
lines changed

README.md

Lines changed: 44 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,25 +31,58 @@
3131

3232
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 by using the `?help` command.
3333

34-
## Installation
35-
36-
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:
34+
## Features
35+
36+
* Aesthetic command interfaces e.g Pagination via reactions
37+
* Highly Customisable:
38+
* Bot activity, prefix, etc.
39+
* Command permissions
40+
* Interface elements (color, responses, reactions, etc.)
41+
* Snippets and *command aliases*
42+
* Minimum account/guild age in order to create a thread.
43+
* Scheduled closing - e.g. `?close in 2 hours silently`
44+
* Blocking users e.g. `?block @user spamming for 2 days`
45+
* Get notified/subscribe for thread messages. (`?notify` and `?sub`)
46+
* Linked thread messages
47+
* Editing/deleting a message on one end is synced with the other.
48+
* Thread logs, e.g. https://logs.modmail.tk/example
49+
* When you close a thread, a log link is generated and posted to your log-channel.
50+
* Rendered in styled HTML like Discord.
51+
* Optional login in via Discord to protect your logs.
52+
* See past logs of a user with `?logs`
53+
* Searchable by text queries using `?logs search`
54+
* Optional automatic updates to stay up to date with the latest features.
55+
56+
This list is ever growing thanks to active development and our exceptional contributors.
3757

38-
Interactive installation: [**https://taaku18.github.io/modmail/installation**](https://taaku18.github.io/modmail/installation)
3958

59+
## Installation
4060

41-
# Notable Features
61+
### Heroku
62+
Currently, the easiest way to set up the bot is by using Heroku, a container-based cloud platform. Installation via Heroku is done in your web browser and keeps the bot online 24/7 for free. 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 the [development server](https://discord.gg/etJNHCQ) for help and support.
4263

43-
## Customizability
64+
### Locally
65+
Installation locally for development reasons or otherwise is as follows, you will need `python 3.7` and `pipenv`.
4466

45-
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. The level of customization is ever growing thanks to our exceptional contributors.
67+
Clone the repo
68+
```console
69+
$ git clone https://github.com/kyb3r/modmail
70+
$ cd modmail
71+
```
4672

47-
## Thread Logs
73+
Install dependancies
74+
```console
75+
$ pipenv install
76+
```
4877

49-
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. You have the ability to query and search through logs using the bot via commands. An example of a logged conversation: https://logs.modmail.tk/example.
78+
Rename the `config.json.example` to `config.json` and fill out the fields.
79+
And finally, run the bot.
80+
```console
81+
$ pipenv run python3 bot.py
82+
```
5083

51-
# Contributing
84+
## Contributing
5285

5386
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.
5487

55-
If you use Modmail and love it, consider supporting me on **[Patreon](https://www.patreon.com/kyber)** :heart:
88+
If you use Modmail and love it, consider becoming a patron on **[Patreon](https://www.patreon.com/kyber)** :smile:

0 commit comments

Comments
 (0)