ok

10 files changed, 26 insertions, 319 deletions

diff --git a/.DS_Store b/.DS_Store
index f0c1918..ca6c853 100644
--- a/.DS_Store
+++ b/.DS_Store
diff --git a/CHANGELOG.md b/CHANGELOG.md
deleted file mode 100644
index f4f990b..0000000
--- a/CHANGELOG.md
+++ /dev/null
@@ -1,284 +0,0 @@
-# Changelog
-
-## v2.30.1
-* Fix crash with `responseMessage` and `closeMessage` introduced in v2.30.0
-  ([#369](https://github.com/Dragory/modmailbot/pull/369))
-
-## v2.30.0
-* The following config options now also support multi-line values:
-  * `responseMessage`
-  * `closeMessage`
-  * `botMentionResponse`
-  * `greetingMessage`
-  * `accountAgeDeniedMessage`
-  * `timeOnServerDeniedMessage`
-* When the bot is mentioned on the main server, the log message about this now
-  also includes a link to the message ([#319](https://github.com/Dragory/modmailbot/pull/319))
-* Fix error when supplying all config values from env variables without a config file
-* Fix crash in update checker if the repository value in package.json is set to
-  a GitHub repository without releases (this only applies to forks)
-
-## v2.29.1
-* Fix boolean values in `config.ini` not being handled properly
-
-## v2.29.0
-* **Default configuration format is now .ini**
-  * Existing `config.json` files will continue to work and will not be deprecated
-  * This makes the default configuration format for the bot much more approachable than JSON
-* Config values can now also be loaded from environment variables
-  (see [Configuration](docs/configuration.md#environment-variables) for more details)
-* New rewritten instructions for setting up and using the bot
-* New easy-to-use `start.bat` file for Windows
-* Update several package dependencies
-* Fixed incompatibility with Node.js 10 versions prior to 10.9.0
-
-## v2.28.0
-* Fix error when saving attachments locally with `attachmentStorage` set to `"local"` (default) when the bot's folder is
-  on a different storage device than the system's temp folder
-* Add `attachments` object to the plugin API
-  * This allows plugins to add new storage types via `attachments.addStorageType()`
-  * See the [Plugins section in the README](README.md#plugins) for more details
-
-## v2.27.0
-* The `syncPermissionsOnMove` option now defaults to `true`, which should be more intuitive
-* **Plugins:** Plugin functions are no longer called with 4 arguments. Instead, the function is called with 1 argument,
-which is an object that contains the previous 4 values as properties: `bot`, `knex`, `config`, `commands`.
-This will make it easier to scale the plugin system in the future with new features.
-You can see an [updated example in the README](https://github.com/Dragory/modmailbot/blob/master/README.md#example-plugin-file).
-
-## v2.26.0
-* The bot now waits for the main server(s) and inbox server to become available before initializing.
-This is a potential fix to [#335](https://github.com/Dragory/modmailbot/issues/335).
-This should have little to no effect on smaller servers.
-* The bot status ("Playing") is now reapplied hourly since the status can sometimes disappear
-
-## v2.25.0
-* Fix regression introduced in v2.24.0 where line breaks would get turned to spaces in replies and snippets ([#304](https://github.com/Dragory/modmailbot/issues/304))
-* Replace the internal command handler with a new one. This should be fairly thoroughly tested, but please report any issues you encounter!
-* Plugins are now called with a fourth parameter that allows you to easily add specific types of commands
-  * Due to the command handler change, any calls to `bot.registerCommand` should be replaced with the new system
-
-## v2.24.0
-* Switch to the new stable version of Eris (0.10.0) instead of the dev version
-
-## v2.23.2
-* Update Node.js version check at startup to require Node.js 10
-
-## v2.23.1
-* Updated required Node.js version in .nvmrc and README (v10 is now the minimum)
-
-## v2.23.0
-* Add update notifications. The bot will check for new versions every 12 hours and notify moderators at the top of new
-modmail threads when there are new versions available. Can be disabled by setting the `updateNotifications` option to `false`.
-New available versions are also shown in `!version`.
-  * If you have forked the repository and want to check for updates in your own repository instead,
-  change the `repository` value in `package.json`
-* Add basic support for plugins. See the **Plugins** section in README for more information.
-* Add support for snippet arguments. To use these, put {1}, {2}, etc. in the snippet text and they will be replaced by the given arguments when using the snippet.
-* Add support for multiple `mentionRole` config option values in an array
-* Add `commandAliases` config option to set custom command aliases
-* Add support for timed blocks. Simply specify the duration as the last argument in `!block` or `!unblock`.
-* Add pagination to `!logs`
-
-## v2.22.0
-* Add `guildGreetings` option to allow configuring greeting messages on a per-server basis
-* Add `rolesInThreadHeader` option to show the user's roles in the modmail thread's header
-
-## v2.21.3
-* Fix crash caused by Nitro Boosting notifications
-
-## v2.21.2
-* Update Eris to fix crashes with news channels and nitro boosting
-
-## v2.21.1
-* "Account age" and "time on server" requirements are now ignored when using `!newthread`
-
-## v2.21.0
-* Add `requiredTimeOnServer` and `timeOnServerDeniedMessage` config options to restrict modmail from users who have just joined the server. Thanks [@reboxer](https://github.com/reboxer) ([#270](https://github.com/Dragory/modmailbot/pull/270))!
-
-## v2.20.0
-* Add `categoryAutomation` option to automate thread categories. Currently supported sub-options:
-  * `newThread` - same as `newThreadCategoryId`, the default category for new threads
-  * `newThreadFromGuild` - default category on a per-guild basis, value is an object with guild IDs as keys and category IDs as values 
-* Threads should now include member information (nickname, joined at, etc.) more reliably
-* Thread header now also includes the member's current voice channel, if any
-
-## v2.19.0
-* Add `attachmentStorage` option to control where attachments are saved. Currently supported:
-  * `"local"` (default) - Same as before: attachments are saved locally on the machine running the bot and served through the bot's web server
-  * `"discord"` - Attachments are saved on a special Discord channel specified by the `attachmentStorageChannelId` option
-* Add `syncPermissionsOnMove` option. When enabled, thread channel permissions are synced with the category when the thread is moved with `!move`.
-* Add support for scheduling `!suspend`. Works the same way as with `!close`, just specify the time after the command. Can be cancelled with `!suspend cancel`.
-* Scheduled `!close` can now be silent - just add `silent` as an argument to the command before or after the schedule time
-* The schedule time format for `!close` is now stricter and times with whitespace (e.g. `2 h 30 m`) no longer work. Use e.g. `2h30m` instead.
-* `!loglink` can now be used in suspended threads
-* User can now be mentioned in `botMentionResponse` by adding `{userMention}` to the response text. Thanks @reboxer (#225)!
-* Fixed a small mistake in README, thanks @GabrielLewis2 (#226)!
-
-## v2.18.0
-* Add `silent` option to `!close` (e.g. `!close silent`) to close threads without sending the specified `closeMessage`
-* Update some package versions (may help with sqlite3 install issues)
-
-## v2.17.0
-* Add `mentionUserInThreadHeader` option. When set to `true`, mentions the thread's user in the thread header. Fixes #152.
-* Add `botMentionResponse` option. If set, the bot auto-responds to bot mentions with this message. Fixes #143.
-* Fix member info sometimes missing in thread header. Thanks @Akhawais (#136)! 
-* Add support for role and user IDs in inboxServerPermission instead of just permission names
-* Allow specifying multiple values (an array) for inboxServerPermission. Members will be considered "staff" if they pass any of the values.
-* Update Eris to 0.9.0, Knex to 0.15.2
-* Add support for sending anonymous snippets. By default, you can do this by using `!!!` instead of `!!`. Fixes #82.
-* Add `snippetPrefixAnon` option
-* Add `allowUserClose` option. When set to `true`, users can use the close command to close threads by themselves.
-* Fix `allowMove` missing from README. Thanks @AndreasGassmann (#126)!
-
-## v2.16.0
-* Add support for a .js config file (export config with `module.exports`)
-
-## v2.15.2
-* Update several other packages as well
-
-## v2.15.1
-* Update `node-sqlite3` dependency to hopefully fix installation issues on some setups
-
-## v2.15.0
-* Add `smallAttachmentLimit` config option to control the max size of attachments forwarded by `relaySmallAttachmentsAsAttachments`
-* Fix crash when `closeMessage` failed to send
-* Handle webserver errors gracefully
-
-## v2.14.1
-* Don't alert for main server pings if the pinger is a bot
-
-## v2.14.0
-* Changed `requiredAccountAge` to be in hours instead of days
-
-## v2.13.0
-* Added `requiredAccountAge` and `accountAgeDeniedMessage` options for restricting how new accounts can message modmail
-
-## v2.12.0
-* Added `closeMessage` option. This option can be used to send a message to the user when their modmail thread is closed.
-* Documented `pingOnBotMention` option
-
-## v2.11.1
-* Fixed greetings not being sent since multi-server support was added in 2.9.0
-
-## v2.11.0
-* Config files are now parsed using [JSON5](https://json5.org/), allowing you to use comments, trailing commas, and other neat things in your config.json
-* When using multiple main guilds, the originating guild name is now always included at the top of the thread (if possible).
-Previously, if the user that messaged modmail was on only one of the guilds, the guild name would not be shown at the top.
-* Fixed crash when a user edited a message in their DMs with modmail without an open thread
-* Small fixes to category name matching when using `!move`
-* Fixed crash when the bot was unable to send an auto-response to a user
-* Added option `pingOnBotMention` (defaults to `true`) that allows you to control whether staff are pinged when the bot is mentioned
-* Long messages are now chunked so they don't fail to send due to added length from e.g. user name
-
-## v2.10.1
-* Changed timed close default unit from seconds to minutes.
-This means that doing e.g. `!close 30` now closes the thread in 30 *minutes*, not seconds.
-
-## v2.10.0
-* Added `!alert`  
-Using `!alert` in a modmail thread will ping you the next time the thread gets a new reply.
-Use `!alert cancel` to cancel.
-
-## v2.9.1
-* If using multiple main guilds, the originating server is now specified in bot mention notifications
-
-## v2.9.0
-* Added multi-server support.  
-Multi-server support allows you to set an array of ids in mainGuildId.
-Nickname and join date will be displayed for each main guild the user is in.
-* Information posted at the top of modmail threads now also includes time since the user joined the guild(s)
-* Added `!id`  
-`!id` posts the user ID of the current thread. Useful on mobile when you need to get the user ID.
-* Added `!newthread`  
-`!newthread <userid>` opens a new thread with the specified user
-* Fixed a crash when the bot was unable to send a greeting message due to the user's privacy options
-
-## v2.8.0
-* Added a `!version` command for checking the version of the bot you're running
-
-## v2.7.0
-* Split more code from main.js to individual module files
-
-## v2.6.0
-* Warn the user if new dependencies haven't been installed
-* `!close` now supports `d` for days in the delay
-* `!close` is now stricter about the time format
-
-## v2.5.0
-* Commands used in inbox threads are now saved in logs again
-* Moved more of the code to individual plugin files
-
-## v2.4.1-v2.4.4
-* Fix errors on first run after upgrading to v2.2.0
-* Various other fixes
-
-## v2.4.0
-* Add thread suspending. A modmail thread can now be suspended with `!suspend`. Suspended threads will function as closed until unsuspended with `!unsuspend`.
-
-## v2.3.2
-* Auto-close threads if their modmail channel is deleted
-
-## v2.3.1
-* Fixed incorrect default value for `mentionRole` (was `null`, should've been `"here"`)
-
-## v2.3.0
-* Added `mentionRole` configuration option ([#59](https://github.com/Dragory/modmailbot/pull/59)). This option can be used to set the role that is pinged when new threads are created or the bot is mentioned. See README for more details.
-
-## v2.2.0
-* Added the ability to schedule a thread to close by specifying a time after `!close`, e.g. `!close 1h`. The scheduling is cancelled if a new message is sent to or received from the user.
-
-## v2.1.0
-* Added typing proxy ([#48](https://github.com/Dragory/modmailbot/pull/48)):
-  * If the `typingProxy` config option is enabled, any time a user is typing to modmail in their DMs, the modmail thread will show the bot as "typing" 
-  * If the `typingProxyReverse` config option is enabled, any time a moderator is typing in a modmail thread, the user will see the bot "typing" in their DMs
-
-## v2.0.1
-* The link to the current thread's log is no longer posted to the top of the thread. Use `!loglink` instead.
-
-## v2.0.0
-* Rewrote large parts of the code to be more modular and maintainable. There may be some new bugs because of this - please report them through GitHub issues if you encounter any!
-* Threads, logs, and snippets are now stored in an SQLite database. The bot will migrate old data on the first run.
-* Small attachments (<2MB) from users can now be relayed as Discord attachments in the modmail thread with the `relaySmallAttachmentsAsAttachments` config option. Logs will have the link as usual.
-* Fixed system messages like pins in DMs being relayed to the thread
-* Fixed channels sometimes being created without a category even when `newThreadCategoryId` was set
-* Removed timestamps from threads by default. Logs will still have accurate timestamps. Can be re-enabled with the `threadTimestamps` config option.
-* Added `!move` command to move threads between categories. Can be enabled with the `allowMove` config option, disabled by default.
-
-## Sep 22, 2017
-* Added `newThreadCategoryId` option. This option can be set to a category ID to place all new threads in that category.
-
-## Sep 20, 2017
-* Fixed crash when the bot was unable to find or create a modmail thread
-* Reduced error log spam in case of network errors from Eris
-* Fixed unintended error when a message was ignored due to an "accidental thread" word
-
-## Sep 19, 2017
-* Added `logChannelId` option
-* Some code clean-up. Please open an issue if you encounter any bugs!
-* The bot now throws an error for unknown options in `config.json` (assuming they're typos) and tells you if you haven't configured the token or mail guild id.
-
-## Aug 3, 2017
-* Fixed user nicknames not showing in new threads
-* The "manageRoles" permission is no longer required to use commands on the inbox server.  
-This can be configured with the `inboxServerPermission` config option.
-
-## July 24, 2017
-* Commands are now case-insensitive (so !close, !Close, and !CLOSE all work)
-* The before/after prefixes in edit notifications are now the same length, making it easier to spot the edited part
-* Non-ASCII names should now result in better channel names (not just "unknown")
-
-## May 18, 2017
-* Identical edits are now ignored
-* New thread notification (with @ here ping) is now posted in the thread instead of the inbox server default channel
-* Thread close notifications no longer ping the user who closed the thread
-* Received attachments are now only linked once the bot has saved them (should fix embeds)
-* Replies now use your nickname, if any
-* Several messages are now ignored for thread creation ("ok", "thanks", and similar)
-* Logs from !logs are now sorted in descending order (newest first)
-
-## Feb 15, 2017
-More info is now available at the beginning of modmail threads.
-
-## Feb 10, 2017
-Major rewrite. Includes anonymous replies (!ar), stability improvements, and server greeting feature.
diff --git a/LICENSE.md b/LICENSE.md
deleted file mode 100644
index f682d0f..0000000
--- a/LICENSE.md
+++ /dev/null
@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2017 Miikka Virtanen
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
diff --git a/db/data.sqlite b/db/data.sqlite
index 967e6c5..becf7ec 100644
--- a/db/data.sqlite
+++ b/db/data.sqlite
diff --git a/modmailbot-pm2.json b/modmail-pm2.json
index 6322645..f8b1af9 100644
--- a/modmailbot-pm2.json
+++ b/modmail-pm2.json
@@ -1,6 +1,6 @@
 {
     "apps": [{
-        "name": "ModMailBot",
+        "name": "ModMail",
         "cwd": "./",
         "script": "npm",
         "args": "start"
diff --git a/package-lock.json b/package-lock.json
index baca952..5f8cf7d 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,6 +1,6 @@
 {
-  "name": "modmailbot",
-  "version": "2.29.1",
+  "name": "modmail",
+  "version": "2.30.1",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
diff --git a/package.json b/package.json
index f3052ff..b936b23 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "modmailbot",
-  "version": "2.30.1",
+  "name": "modmail",
+  "version": "1.0.0",
   "description": "",
   "license": "MIT",
   "main": "src/index.js",
@@ -10,10 +10,6 @@
     "test": "echo \"Error: no test specified\" && exit 1",
     "lint": "eslint ./src"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Dragory/modmailbot"
-  },
   "dependencies": {
     "eris": "^0.11.1",
     "humanize-duration": "^3.12.1",
diff --git a/src/main.js b/src/main.js
index b8ef515..24d6b22 100644
--- a/src/main.js
+++ b/src/main.js
@@ -27,6 +27,7 @@ const version = require('./modules/version');
 const newthread = require('./modules/newthread');
 const idModule = require('./modules/id');
 const alert = require('./modules/alert');
+const help = require('./modules/help');
 
 const {ACCIDENTAL_THREAD_MESSAGES} = require('./data/constants');
 
@@ -258,7 +259,8 @@ function initPlugins() {
     version,
     newthread,
     idModule,
-    alert
+    alert,
+    help
   ];
 
   const plugins = [...builtInPlugins];
diff --git a/src/modules/help.js b/src/modules/help.js
new file mode 100644
index 0000000..076b371
--- /dev/null
+++ b/src/modules/help.js
@@ -0,0 +1,13 @@
+const utils = require("../utils");
+const config = require('../config');
+
+module.exports = ({ bot, knex, config, commands }) => {
+  commands.addInboxServerCommand('help', [], async (msg, args, thread) => {
+    let embed = {
+      title: "ModMail - Help",
+      type: "rich",
+      description: "[mm.bot/commands](https://gist.github.com/8cy/1ecb7106d096f77394122cfa4fae77ad)"
+    };
+    utils.postSystemMessageWithFallback(msg.channel, thread, { embed });
+  });
+};
diff --git a/src/modules/version.js b/src/modules/version.js
index 033fbf0..fc15d9b 100644
--- a/src/modules/version.js
+++ b/src/modules/version.js
@@ -17,13 +17,14 @@ module.exports = ({ bot, knex, config, commands }) => {
 
     let response = `Modmail v${packageVersion}`;
 
-    let isGit;
+    /* let isGit;
     try {
       await access(GIT_DIR);
       isGit = true;
     } catch (e) {
       isGit = false;
-    }
+    } */
+    let isGit = false;
 
     if (isGit) {
       let commitHash;
@@ -41,12 +42,12 @@ module.exports = ({ bot, knex, config, commands }) => {
       response += ` (${commitHash.slice(0, 7)})`;
     }
 
-    if (config.updateNotifications) {
+    /* if (config.updateNotifications) {
       const availableUpdate = await updates.getAvailableUpdate();
       if (availableUpdate) {
         response += ` (version ${availableUpdate} available)`;
       }
-    }
+    } */
 
     utils.postSystemMessageWithFallback(msg.channel, thread, response);
   });