Merge from "master"

Author: Taaku18

CHANGELOG.md

@@ -4,43 +4,104 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# v2.9.1
+Changed order of arguments for the contact command. This is so that you can use aliases to their full potential. 
+For example: 
+- `contact "Recruitment Category" @somedude` 
+
+You can add an alias by doing: `alias add recruit contact "Recruitment Category"`
+
+Now you can use the alias via: `recruit @somedude`
+
+# v2.9.0
+
+### Added
+- New command `note` will add a system message to your thread logs. This is useful for noting the context of a conversation.
+
+# v2.8.1
+
+### Fixed
+- Fixed bug where thread logs were getting duplicated when using the `contact` command.
+- Fixed bug where the wrong key was used for logs which caused some `log` command log links to point to an HTTP 404 Not Found.
+  - A minor oversight from commit 1ba74d9.
+
+# v2.8.0
+
+### Changed
+- Major improvement in viewing thread logs.
+- Log links are now rendered in HTML instead of plain text.
+
+# v2.7.2
+
+### Added 
+- `config options` command to see a list of valid config variables that you can modify.
+
+### Security
+Thread channels will now default to being private (`@everyone`'s read message perms set to `false`).
+  - If the thread creation category could not be resolved.
+  - This will save you from some trouble if for whatever reason your configuration gets messed up.
+
+# v2.7.1
+
+### Changed
+
+- All reference to "modmail" / "Mod Mail" / "ModMail" are changed to "Modmail".
+- `log_channel_id` is now part of the config upon `setup`.
+- Added the ability to set where threads are created using the `main_category_id` configuration option.
+
+### Important Note
+
+- If your Modmail bot was set up a long time ago, you may experience an issue where messages were sent outside of the category.
+  - To fix this, set `main_category_id` to the ID of the Modmail category.
+  
+# v2.7.0
+
+### Changed
+
+- `move` command now syncs thread channel permissions with the category that it was moved to.
+- `contact` command now supports an optional category argument (where the thread channel will be created).
+
 # v2.6.3
 
-Fixed small issue in thread finding.
+Fixed small issue with finding thread.
 
 # v2.6.2
 
-Fixed log urls for selfhosting users. (This shouldn't affect anyone)
+Fixed log URLs for self-hosting users.
+(This shouldn't affect anyone.)
 
 # v2.6.1
 
 ### Fixed
-- API BASE URL
+- Replaced the testing `API_BASE_URL` with the actual URL.
 
 # v2.6.0
 
 Mostly internal changes. Some are slightly breaking. Keep a lookout for broken features and report them on our server.
 
 ### Added
-- `threads` is now a default alias to `logs`
+- `threads` is now a default alias to `logs`.
 
 ### Changed
 - Log URLs are moved to their own collection.
-- Log URLs are now `https://logs.modmail.tk/LOGKEY`, no more numbers before the logkey.
-- We still support the numbers so as to not break everyone's urls so quickly but both work atm :p
+- Log URLs are now `https://logs.modmail.tk/LOGKEY`, no more numbers before the log key.
+- We still support the numbers so as to not break everyone's URLs so quickly but both work at the moment.
 - This is a huge change to the backend logging and there might be migration errors. If so, please contact us at our [discord server](https://discord.gg/2fMbf2N)
 
 # v2.5.2
 
-Non-Breaking Internal Changes. (This shouldn't affect anyone.)
+Non breaking internal changes.
+(This shouldn't affect anyone.)
 
 # v2.5.0
 
-Non-Breaking Internal Changes. (This shouldn't affect anyone.)
+Non breaking internal changes.
+(This shouldn't affect anyone.)
 
 ### Background
 Bots hosted by Heroku restart at least once every 27 hours.
-During this period, local caches are deleted, which results in the inability to set the scheduled close time to longer than 24 hours. This update resolves this issue. [PR #135](https://github.com/kyb3r/modmail/pull/135)
+During this period, local caches are deleted, which results in the inability to set the scheduled close time to longer than 24 hours. This update resolves this issue. 
+ - [PR #135](https://github.com/kyb3r/modmail/pull/135)
 
 
 ### Changed
@@ -49,7 +110,7 @@ During this period, local caches are deleted, which results in the inability to
    - Loaded upon bot restart.
    - Deleted when a thread is closed.
  - Use `call_later()` instead of `sleep()` for scheduling.
- 
+
 # v2.4.5
 
 ### Fixed
@@ -65,42 +126,42 @@ Fixed a bug in activity command where it would fail to set the activity on bot r
 This update shouldn't affect anyone.
 
 ### Changed
- - Moved self-hosted log viewer to a separate repo. 
- 
+ - Moved self-hosted log viewer to a separate repo.
+
 # v2.4.2
 
-### Added 
+### Added
 - Ability to set your own Twitch URL for `streaming` activity status.
 
 # v2.4.1
 
-### Fixed 
-- Small bug in `activity` command. 
+### Fixed
+- Small bug in `activity` command.
 
 # v2.4.0
 
 Breaking changes.
 
-### Added 
+### Added
 - Added the `activity` command for setting the activity
 - [PR #131](https://github.com/kyb3r/modmail/pull/131#issue-244686818) this supports multiple activity types (`playing`, `watching`, `listening` and `streaming`).
 
 ### Removed
-- Removed the deprecated `status` command. 
-- This also means you will have to reset your bot status with the `activity` command, as `status` command is removed. 
+- Removed the deprecated `status` command.
+- This also means you will have to reset your bot status with the `activity` command, as `status` command is removed.
 
 # v2.3.0
 
-### Added 
+### Added
 - Ability to self-host logs.
 
 ### Changed
 - Improved format for log channel embeds.
-- Roles are now comma separated in info embed.
+- Roles are now comma-separated in info embed.
 - This only applies to separate server setups.
 
 ### Fixed
-- Bug in subscribe command, it will now unsubscribe after a thread is closed.
+- Bug in subscribe command; it will now unsubscribe after a thread is closed.
 
 # v2.2.0
 
@@ -141,47 +202,47 @@ Breaking changes.
 
 # v2.0.9
 
-### Added 
+### Added
 - Support for custom blocked emoji and sent emoji.
 - Use the `config set blocked_emoji` or `sent_emoji` commands.
 
 ### Quick Fix
-- Support multiple image and file attachments in one message.
+- Support multiple images and file attachments in one message.
 - This is only possible on mobile so its good to handle it in code.
 
 # v2.0.8
 
 Improvements to commands and new config options available.
 
-### Added 
+### Added
 - Added the ability to use your own log channel.
     - You can do this via the `config set log_channel_id <id>` command.
 - Added the ability to use your own main inbox category.
     - You can do this via the `config set main_category_id <id>` command.
 
 ### Changed
-- You now have the ability to supply a reason when blocking a user. 
+- You now have the ability to supply a reason when blocking a user.
 - Blocked users are now stored in the database instead of in the channel topic.
     - This means you can delete the top channel in the modmail category now. (Migrate first though.)
 
 # v2.0.7
 
-New command and improvements in bot update message interfaces. 
+New command and improvements in bot update message interfaces.
 
-### Added 
+### Added
 - Added a `changelog` command to view the bot's changelog within discord.
 
 ### Changed
-- Update command now shows latest changes directly from the [CHANGELOG.md](https://modmail.tk/) in the repo.
-- Auto update messages also show latest changes from repo.
-- Remove latest changes section from the `about` command.
+- `update` command now shows the latest changes directly from the [CHANGELOG.md](https://modmail.tk/) in the repo.
+- Auto update messages also show the latest changes from the GitHub repo.
+- Removed "latest changes" section from the `about` command.
 
 # v2.0.6
 
 ### Fixed
 - Fix logs sending duplicated thread close logs.
 - The bot will now tell you that a user is no longer in the server when you try to reply to a thread.
-    - Before this, it looked like you replied to the thread but in reality the message didnt get sent.
+    - Before this, it looked like you replied to the thread, but in reality, the message didn't get sent.
 
 # v2.0.5
 
@@ -192,22 +253,22 @@ New command and improvements in bot update message interfaces.
 # v2.0.4
 
 ### Fixed
-- Fixed a one off bug where the channel topic disappears, but modmail operations should still continue.
+- Fixed a one-off bug where the channel topic disappears, but modmail operations should still continue.
 - Fixed `linked_message_id` issues.
 
 # v2.0.3
 
 Fixed some issues with how data is displayed in the info embed.
 
 ### Fixed
-- Thread creation embed now shows the correct amount of past logs. 
+- Thread creation embed now shows the correct number of past logs.
 - If using a separate server setup, roles in the info embed now are shown as names instead of mentions.
     - This is due to the fact that you can't mention roles across servers.
 
 # v2.0.2
 
 ### Security
-- Made the `logs` command require "manage messages" permissions to execute. 
+- Made the `logs` command require "manage messages" permissions to execute.
     - Before this patch, anyone could use the `logs` commands.
 
 # v2.0.1
@@ -223,15 +284,15 @@ Bug fixes and minor improvements.
 
 # v2.0.0
 
-This release introduces the use of our centralized [API service](https://github.com/kyb3r/webserver) to enable dynamic configuration, auto-updates, and thread logs. 
-To use this release you must acquire an API token from https://modmail.tk. 
+This release introduces the use of our centralized [API service](https://github.com/kyb3r/webserver) to enable dynamic configuration, auto-updates, and thread logs.
+To use this release you must acquire an API token from https://modmail.tk.
 Read the updated installation guide [here](https://github.com/kyb3r/modmail/wiki/installation).
 
 ### Changed
 - Stability improvements through synchronization primitives.
 - Refactor thread management and code.
 - Update command now uses `api.modmail.tk`.
-- `contact` command no longer tells the user you messaged them 👻 
+- `contact` command no longer tells the user you messaged them 👻
 
 ### Fixed
 - `status` command now changes playing status indefinitely.

README.md

@@ -39,32 +39,32 @@
 
 <img src='https://i.imgur.com/GGukNDs.png' align='right' height=300>
 
-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 a message, simply use the command `reply` in the channel. See a full list of commands [below](#features-and-commands).
+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).
 
 
 ## Installation
 
-You have two options for using this bot, hosting on Heroku or self hosting the bot. If you choose to install the bot using Heroku, you do not need to download anything. Read the installation guide [here](https://github.com/kyb3r/modmail/wiki/Installation) or watch the **[video tutorial](https://youtu.be/TH_1QfKUl_k)**. If you have any problems join our [discord server](https://discord.gg/etJNHCQ) or just join anyways :wink:
+You have two options for using this bot, host on Heroku or self-host the bot. If you choose to install the bot using Heroku, you will not need to download anything. Read the **[installation guide](https://github.com/kyb3r/modmail/wiki/Installation)** or watch the **[video tutorial](https://youtu.be/TH_1QfKUl_k)**. If you ran 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:
 
-## What is heroku?
+## What is Heroku?
 
-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 Mod Mail to 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? Config and logs are stored in a [centralised web service](https://modmail.tk) hosted by us. This enables you to get started easily and fast.
+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.
 
-## Self hosted logs
+## Self-hosted logs
 
-If you want complete control over your data and do not want to use the centralised API service, you can self host your logs. You can do this by adding two config variables: 
+If you want complete control over your data and do not want to use the centralized API service, you can self-host your logs. We recommend this if you want stability and security for your bot. You can do this by adding two config variables: 
 
-* `MONGO_URI` - Mongodb connection URI, you can get a free 500mb cluster from [mongodb atlas](https://www.mongodb.com/cloud/atlas).
-* `LOG_URL` - The url of your log viewer heroku app (`https://yourlogviewerappname.herokuapp.com`)
+* `MONGO_URI` - MongoDB connection URI, you can get a free 500 MB cluster from [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).
+* `LOG_URL` - The URL of your log viewer Heroku app (`https://yourlogviewerappname.herokuapp.com`)
 
-You also need to create a separate heroku app for the log viewer that you can deploy from [here](https://github.com/kyb3r/logviewer).
+You also need to create a separate Heroku app for the log viewer that you can deploy from [here](https://github.com/kyb3r/logviewer).
 
 ## Features and Commands
 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).
 
 
 ### Automatic Updates
-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. 
+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. 
 
 ## Contributing
 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.

app.json

@@ -1,6 +1,6 @@
 {
-  "name": "ModMail",
-  "description": "An easy to install ModMail bot for Discord - DM to contact mods!",
+  "name": "Modmail",
+  "description": "An easy to install Modmail bot for Discord - DM to contact mods!",
   "repository": "https://github.com/kyb3r/modmail",
   "env": {
     "TOKEN": {

bot.py

@@ -22,7 +22,7 @@
 SOFTWARE.
 """
 
-__version__ = '2.6.3'
+__version__ = '2.9.1'
 
 import discord
 from discord.enums import ActivityType
@@ -163,7 +163,7 @@ def main_category(self):
 
         if self.modmail_guild:
             return discord.utils.get(self.modmail_guild.categories,
-                                     name='Mod Mail')
+                                     name='Modmail')
 
     @property
     def blocked_users(self):