You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
34
52
35
53
## How does it work?
36
-
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.
54
+
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.
37
55
38
56
All threads are logged and you can view previous threads through the corresponding generated log link. [**Example**](https://logs.modmail.tk/example)
39
57
@@ -61,7 +79,7 @@ This list is ever growing thanks to active development and our exceptional contr
61
79
62
80
## Installation
63
81
64
-
### Locally
82
+
### Locally
65
83
Installation locally for development reasons or otherwise is as follows, you will need `python 3.7`.
66
84
67
85
Clone the repo
@@ -75,15 +93,15 @@ Install dependancies
75
93
$ pipenv install
76
94
```
77
95
78
-
Rename the `.env.example` to `.env` and fill out the fields.
96
+
Rename the `.env.example` to `.env` and fill out the fields.
79
97
And finally, run the bot.
80
98
```console
81
99
$ pipenv run python3 bot.py
82
100
```
83
101
84
102
### Hosting for patrons
85
103
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!
104
+
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!
87
105
88
106
### Heroku
89
107
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.
@@ -95,8 +113,8 @@ You can also set up autoupdates. To do this, [install the Pull app in your fork]
95
113
96
114
Sepcial thanks to our sponsors for supporting the project.
@@ -108,6 +126,6 @@ Modmail supports the use of third party plugins to extend or add functionality t
108
126
109
127
## Contributing
110
128
111
-
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.
129
+
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.
112
130
113
-
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)**.
131
+
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)**.
0 commit comments