From ac64e28d03c681b4f5a23d7ebad5eb56b5c57f40 Mon Sep 17 00:00:00 2001 From: Dragory Date: Sat, 24 Feb 2018 13:09:07 +0200 Subject: [PATCH] Update README and CHANGELOG for the 2.0.0 update --- CHANGELOG.md | 2 +- README.md | 10 +++++++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 547845c..bb8ee79 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ * 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 +* 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. diff --git a/README.md b/README.md index 7ac3ae2..739819b 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,13 @@ Moderators and admins can then reply to these threads, and these responses are r Inspired by Reddit's modmail system. -### NOTE! If you're upgrading from a version prior to Feb 18, be sure to run `npm install` again and follow the on-screen instructions after `npm start`. +### NOTE! If you're upgrading from a version prior to Feb 24 2018: +* Take backups +* Run `npm install` again +* Follow the on-screen instructions after `npm start` ## Setup -1. Install Node.js 8 or higher +1. Install Node.js 8.9.4 (LTS) or higher 2. Clone or download this repository 3. Create a Discord server to be used as the modmail inbox 4. Make a copy of the file `config.example.json` in the same folder and name the copy `config.json`. Open the file and fill in the values. @@ -38,7 +41,8 @@ See [CHANGELOG.md](CHANGELOG.md) `!logs` Lists previous modmail logs with this user `!block` Blocks the user from using modmail `!unblock` Unblocks the user from using modmail -`!!shortcut` Reply with a snippet. Replace `shortcut` with the snippet's actual shortcut. +`!!shortcut` Reply with a snippet. Replace `shortcut` with the snippet's actual shortcut. +`!move ` If `allowMove` is enabled, moves the thread channel to the specified category To automatically reply without using !reply or !r, enable `alwaysReply` in the config. `alwaysReplyAnon` sets whether to reply anonymously. If you do not wish to reply, it will ignore any message starting in the prefix (which defaults to !), such as !note