Skip to content

Commit e585b23

Browse files
committed
Update README.md
1 parent 40fee5c commit e585b23

File tree

1 file changed

+52
-36
lines changed

1 file changed

+52
-36
lines changed

README.md

Lines changed: 52 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div align="center">
22
<img src="https://i.imgur.com/o558Qnq.png" align="center">
33
<br>
4-
<strong><i>A feature rich Modmail bot for Discord.</i></strong>
4+
<strong><i>A feature-rich Modmail bot for Discord.</i></strong>
55
<br>
66
<br>
77

@@ -32,70 +32,86 @@
3232

3333
Modmail is similar to Reddit's Modmail both in functionality and purpose. It serves as a shared inbox for server staff to communicate with their users in a seamless way.
3434

35+
This bot is free for everyone and always will be. If you like this project and would like to show your appreciation, you can support us on **[Patreon](https://www.patreon.com/kyber)**, cool benefits included!
36+
3537
## How does it work?
3638
When a member sends a direct message to the bot, a channel or "thread" is created within an isolated category for that member. This channel is where messages will be relayed and where any available staff member can respond to that user.
3739

38-
All threads are logged and you can view previous threads through the corresponding generated log link. Here is an [**example**](https://logs.modmail.tk/example)
40+
All threads are logged and you can view previous threads through the corresponding generated log link. Here is an [**example**](https://logs.modmail.tk/example).
3941

4042
## Features
4143

42-
* **Highly Customisable**
44+
* **Highly Customisable:**
4345
* Bot activity, prefix, category, log channel, etc.
44-
* Fully customisable command permission system.
45-
* Interface elements (color, responses, reactions, etc.)
46-
* Snippets and *command aliases*
47-
* Minimum account/guild age in order to create a thread.
48-
* **Thread logs**
46+
* Command permission system.
47+
* Interface elements (color, responses, reactions, etc).
48+
* Snippets and *command aliases*.
49+
* Minimum duration for accounts to be created before allowed to contact Modmail (`account_age`).
50+
* Minimum duration for member to be in the guild allowed to contact Modmail (`guild_age`).
51+
* **Thread logs:**
4952
* When you close a thread, a [log link](https://logs.modmail.tk/example) is generated and posted to your log channel.
50-
* Rendered in styled HTML like Discord.
51-
* Login in via Discord to protect your logs ([Patron only feature](https://patreon.com/kyber)).
52-
* See past logs of a user with `?logs`
53-
* Searchable by text queries using `?logs search`
54-
* **Robust implementation**
53+
* Native Discord dark-mode feel.
54+
* Markdown/formatting support.
55+
* Login via Discord to protect your logs ([premium Patreon feature](https://patreon.com/kyber)).
56+
* See past logs of a user with `?logs`.
57+
* Searchable by text queries using `?logs search`.
58+
* **Robust implementation:**
5559
* Scheduled tasks in human time, e.g. `?close in 2 hours silently`.
56-
* Editing and deleting messages is synced on both ends.
57-
* Support for the full range of message content (mutliple images, files).
60+
* Editing and deleting messages are synced on all channels.
61+
* Support for the full range of message content (multiple images, files).
5862
* Paginated commands interfaces via reactions.
5963

60-
This list is ever growing thanks to active development and our exceptional contributors. See a full list of documented commands by using the `help` command.
64+
This list is ever-growing thanks to active development and our exceptional contributors. See a full list of documented commands by using the `?help` command.
6165

6266
## Installation
6367

64-
### Locally
65-
Installation locally for development reasons or otherwise is as follows, you will need `python 3.7`.
68+
### Heroku
69+
70+
This bot can be hosted on Heroku.
71+
72+
Installation via Heroku is possible with only your web browser.
73+
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.
74+
75+
You can also set up auto-update. To do this:
76+
- [Fork the repo](https://github.com/kyb3r/modmail/fork).
77+
- [Install the Pull app for your fork](https://github.com/apps/pull).
78+
- Then go to the Deploy tab in your Heroku account, select GitHub and connect your fork.
79+
- Turn on auto-deploy for the `master` branch.
80+
81+
### Hosting for patrons
82+
83+
If you don't want to go through the trouble of setting up your own bot, and want to support this project as well, we offer installation, hosting and maintenance for Modmail bots for [**Patrons**](https://patreon.com/kyber). Join the support server for more info!
84+
85+
### Locally
86+
87+
Installation locally for development reasons or otherwise is as follows, you will need [`python 3.7`](https://www.python.org/downloads/).
88+
Follow the [**installation guide**](https://github.com/kyb3r/modmail/wiki/Installation) and disregard deploying Heroku apps. If you run into any problems, join the [development server](https://discord.gg/etJNHCQ) for help and support.
89+
90+
Clone the repo:
6691

67-
Clone the repo
6892
```console
6993
$ git clone https://github.com/kyb3r/modmail
7094
$ cd modmail
7195
```
7296

73-
Install dependancies
74-
```console
75-
$ pipenv install
76-
```
97+
Install dependencies:
7798

78-
Rename the `.env.example` to `.env` and fill out the fields.
79-
And finally, run the bot.
8099
```console
81-
$ pipenv run python3 bot.py
100+
$ pipenv install
82101
```
83102

84-
### Hosting for patrons
85-
86-
If you don't want to go through the trouble of setting up your own bot, and want to support this project as well, we offer installation, hosting and maintainance for Modmail bots for [**Patrons**](https://patreon.com/kyber). Join the support server for more info!
103+
Rename the `.env.example` to `.env` and fill out the fields. If `.env.example` is hidden, create a text file named `.env` and copy the contents of [`.env.example`](https://raw.githubusercontent.com/kyb3r/modmail/master/.env.example) then modify the values.
87104

88-
### Heroku
89-
This bot can be hosted on heroku. Installation via Heroku is done in your web browser. 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.
105+
Finally, run the bot.
90106

91-
You can also set up autoupdates. To do this, [install the Pull app in your fork](https://github.com/apps/pull). Then go to the Deploy tab in your Heroku account, select GitHub and connect your fork. Turn on auto-deploy for the master branch.
107+
```console
108+
$ pipenv run bot
109+
```
92110

93111
## Plugins
94112

95-
Modmail supports the use of third party plugins to extend or add functionality to the bot. This allows the introduction of niche features as well as anything else outside of the scope of the core functionality of Modmail. A list of third party plugins can be found using the `plugins registry` command. To develop your own, check out the [documentation](https://github.com/kyb3r/modmail/wiki/Plugins) for plugins.
113+
Modmail supports the use of third-party plugins to extend or add functionality to the bot. This allows the introduction of niche features as well as anything else outside of the scope of the core functionality of Modmail. A list of third party plugins can be found using the `plugins registry` command. To develop your own, check out the [documentation](https://github.com/kyb3r/modmail/wiki/Plugins) for plugins.
96114

97115
## Contributing
98116

99-
Contributions to Modmail are always welcome, whether it be improvements to the documentation or new functionality, please feel free make the change. Check out our contribution [guidelines](https://github.com/kyb3r/modmail/blob/master/CONTRIBUTING.md) before you get started.
100-
101-
This bot is free for everyone and always will be. If you like this project and would like to show your appreciation, here's the link for our **[Patreon](https://www.patreon.com/kyber)**.
117+
Contributions to Modmail are always welcome, whether it be improvements to the documentation or new functionality, please feel free to make the change. Check out our contribution [guidelines](https://github.com/kyb3r/modmail/blob/master/CONTRIBUTING.md) before you get started.

0 commit comments

Comments
 (0)