Merge branch 'master' of https://github.com/verixx/modmail

Author: kyb3r

README.md

@@ -1,7 +1,7 @@
 <div align="center">
   <img src="https://i.imgur.com/o558Qnq.png" align="center">
   <br>
-  <strong><i>A simple and functional Modmail bot for Discord.</i></strong>
+  <strong><i>A feature rich Modmail bot for Discord.</i></strong>
   <br>
   <br>
 
@@ -25,31 +25,59 @@
 </div>
 
 
-## How Does Modmail Work?
-
-<img src="https://i.imgur.com/GGukNDs.png" align="right" height="350">
-
-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.
+## What is Modmail?
+
+Modmail's core functionality provides an efficient communications interface between server members and staff. When a member sends a direct message to the bot, a channel 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.
+
+## Features
+
+* **Highly Customisable**
+  * Bot activity, prefix, category, log channel, etc.
+  * Fully customisable command permission system.
+  * Interface elements (color, responses, reactions, etc.)
+  * Snippets and *command aliases*
+  * Minimum account/guild age in order to create a thread.
+* **Thread logs**
+  * When you close a thread, a [log link](https://logs.modmail.tk/example) is generated and posted to your log channel.
+  * Rendered in styled HTML like Discord.
+  * Optional login in via Discord to protect your logs.
+  * See past logs of a user with `?logs`
+  * Searchable by text queries using `?logs search`
+* **Robust implementation**
+  * Scheduled tasks in human time, e.g. `?close in 2 hours silently`.
+  * Editing and deleting messages is synced on both ends.
+  * Support for the full range of message content (mutliple images, files).
+  * Paginated commands interfaces via reactions.
+  
+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.
 
 ## Installation
 
-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:
-
-Interactive installation: [**https://taaku18.github.io/modmail/installation**](https://taaku18.github.io/modmail/installation)
-
-
-# Notable Features
+### Heroku
+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. 
 
-## Customizability
+### Locally 
+Installation locally for development reasons or otherwise is as follows, you will need `python 3.7` and `pipenv`.
 
-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.
+Clone the repo
+```console
+$ git clone https://github.com/kyb3r/modmail
+$ cd modmail
+```
 
-## Thread Logs
+Install dependancies
+```console
+$ pipenv install
+```
 
-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.
+Rename the `config.json.example` to `config.json` and fill out the fields. 
+And finally, run the bot.
+```console
+$ pipenv run python3 bot.py
+```
 
-# Contributing
+## Contributing
 
 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.
 
-If you use Modmail and love it, consider supporting me on **[Patreon](https://www.patreon.com/kyber)** :heart:
+If you use Modmail and love it, consider becoming a patron on **[Patreon](https://www.patreon.com/kyber)** :smile:

cogs/modmail.py

@@ -106,7 +106,7 @@ async def snippets(self, ctx):
 
     @snippets.command(name='add')
     @checks.has_permissions(PermissionLevel.SUPPORTER)
-    async def add_(self, ctx, name: str.lower, *, value):
+    async def snippets_add(self, ctx, name: str.lower, *, value):
         """Add a snippet to the bot config."""
         if 'snippets' not in self.bot.config.cache:
             self.bot.config['snippets'] = {}
@@ -124,7 +124,7 @@ async def add_(self, ctx, name: str.lower, *, value):
 
     @snippets.command(name='remove', aliases=['del', 'delete', 'rm'])
     @checks.has_permissions(PermissionLevel.SUPPORTER)
-    async def remove_(self, ctx, *, name: str.lower):
+    async def snippets_remove(self, ctx, *, name: str.lower):
         """Removes a snippet from bot config."""
 
         if self.bot.config.snippets.get(name):
@@ -386,7 +386,6 @@ def format_log_embeds(self, logs, avatar_url):
             if prefix == 'NONE':
                 prefix = ''
 
-
             log_url = self.bot.config.log_url.strip('/') + f'{prefix}/{key}'
 
             username = entry['recipient']['name'] + '#'
@@ -450,9 +449,9 @@ async def logs(self, ctx, *, member: User = None):
         session = PaginatorSession(ctx, *embeds)
         await session.run()
 
-    @logs.command(name='closed-by')
+    @logs.command(name='closed-by', aliases=['closeby'])
     @checks.has_permissions(PermissionLevel.SUPPORTER)
-    async def closed_by(self, ctx, *, user: User = None):
+    async def logs_closed_by(self, ctx, *, user: User = None):
         """Returns all logs closed by a user."""
         user = user or ctx.author
 
@@ -481,9 +480,9 @@ async def closed_by(self, ctx, *, user: User = None):
         session = PaginatorSession(ctx, *embeds)
         await session.run()
 
-    @logs.command()
+    @logs.command(name='search', aliases=['find'])
     @checks.has_permissions(PermissionLevel.SUPPORTER)
-    async def search(self, ctx, limit: Optional[int] = None, *, query):
+    async def logs_search(self, ctx, limit: Optional[int] = None, *, query):
         """Searches all logs for a message that contains your query."""
 
         await ctx.trigger_typing()
@@ -518,7 +517,7 @@ async def search(self, ctx, limit: Optional[int] = None, *, query):
     @commands.command()
     @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
-    async def reply(self, ctx, *, msg=''):
+    async def reply(self, ctx, *, msg: str):
         """Reply to users using this command.
 
         Supports attachments and images as well as
@@ -531,7 +530,7 @@ async def reply(self, ctx, *, msg=''):
     @commands.command()
     @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
-    async def anonreply(self, ctx, *, msg=''):
+    async def anonreply(self, ctx, *, msg: str):
         """Reply to a thread anonymously.
 
         You can edit the anonymous user's name,
@@ -547,7 +546,7 @@ async def anonreply(self, ctx, *, msg=''):
     @commands.command()
     @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
-    async def note(self, ctx, *, msg=''):
+    async def note(self, ctx, *, msg: str):
         """Take a note about the current thread, useful for noting context."""
         ctx.message.content = msg
         async with ctx.typing():
@@ -579,7 +578,7 @@ async def find_linked_message(self, ctx, message_id):
     @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
     async def edit(self, ctx, message_id: Optional[int] = None,
-                   *, new_message):
+                   *, new_message: str):
         """Edit a message that was sent using the reply command.
 
         If no `message_id` is provided, the
@@ -758,7 +757,6 @@ async def unblock(self, ctx, *, user: User = None):
         use only.
         """
 
-
         if user is None:
             thread = ctx.thread
             if thread:
@@ -803,18 +801,19 @@ async def unblock(self, ctx, *, user: User = None):
     @commands.command()
     @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
-    async def delete(self, ctx, message_id = None):
+    async def delete(self, ctx, message_id: Optional[int] = None):
         """Delete a message that was sent using the reply command.
 
         Deletes the previous message, unless a message ID is provided, which in that case,
         deletes the message with that message ID.
         """
         thread = ctx.thread
 
-        try:
-            message_id = int(message_id)
-        except ValueError:
-            raise commands.BadArgument('An integer message ID needs to be specified.')
+        if message_id is not None:
+            try:
+                message_id = int(message_id)
+            except ValueError:
+                raise commands.BadArgument('An integer message ID needs to be specified.')
 
         linked_message_id = await self.find_linked_message(ctx, message_id)
 

cogs/plugins.py

@@ -124,9 +124,9 @@ async def plugin(self, ctx):
         cmd = self.bot.get_command('help')
         await ctx.invoke(cmd, command='plugin')
 
-    @plugin.command()
+    @plugin.command(name='add')
     @checks.has_permissions(PermissionLevel.OWNER)
-    async def add(self, ctx, *, plugin_name):
+    async def plugin_add(self, ctx, *, plugin_name):
         """Adds a plugin"""
         if plugin_name in self.bot.config.plugins:
             return await ctx.send('Plugin already installed')
@@ -164,9 +164,9 @@ async def add(self, ctx, *, plugin_name):
                 await message.edit(content='Invalid plugin name format. '
                                    'Use username/repo/plugin.')
 
-    @plugin.command()
+    @plugin.command(name='remove', aliases=['del', 'delete', 'rm'])
     @checks.has_permissions(PermissionLevel.OWNER)
-    async def remove(self, ctx, *, plugin_name):
+    async def plugin_remove(self, ctx, *, plugin_name):
         """Removes a certain plugin"""
         if plugin_name in self.bot.config.plugins:
             username, repo, name = self.parse_plugin(plugin_name)
@@ -199,9 +199,9 @@ def onerror(func, path, exc_info):
         else:
             await ctx.send('Plugin not installed.')
 
-    @plugin.command()
+    @plugin.command(name='update')
     @checks.has_permissions(PermissionLevel.OWNER)
-    async def update(self, ctx, *, plugin_name):
+    async def plugin_update(self, ctx, *, plugin_name):
         """Updates a certain plugin"""
         if plugin_name not in self.bot.config.plugins:
             return await ctx.send('Plugin not installed')
@@ -232,9 +232,9 @@ async def update(self, ctx, *, plugin_name):
                     except DownloadError as exc:
                         await ctx.send(f'Unable to start plugin: `{exc}`')
 
-    @plugin.command(name='list')
+    @plugin.command(name='list', aliases=['show', 'view'])
     @checks.has_permissions(PermissionLevel.OWNER)
-    async def list_(self, ctx):
+    async def plugin_list(self, ctx):
         """Shows a list of currently enabled plugins"""
         if self.bot.config.plugins:
             msg = '```\n' + '\n'.join(self.bot.config.plugins) + '\n```'