From 223c196b957de337246914c78a3aeaf180f0e875 Mon Sep 17 00:00:00 2001 From: Dragory Date: Sun, 18 Feb 2018 20:06:40 +0200 Subject: [PATCH] Update README and CHANGELOG with info about the attachment relaying option --- CHANGELOG.md | 2 +- README.md | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a05f808..2f63acd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ ## 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 are now relayed as Discord attachments in the modmail thread. Logs will have the link as usual. +* 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 diff --git a/README.md b/README.md index 9c9f2f5..cc1d8a7 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ 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`. + ## Setup 1. Install Node.js 8 or higher 2. Clone or download this repository @@ -15,6 +17,9 @@ Inspired by Reddit's modmail system. 6. Add bot to servers, and make sure to give it proper permissions on the mail server. 7. Run the bot: `npm start` +## Changelog +See [CHANGELOG.md](CHANGELOG.md) + ## Commands ##### Anywhere on the modmail inbox server @@ -61,3 +66,4 @@ These go in `config.json`. See also `config.example.json`. |inboxServerPermission|None|Permission required to use bot commands on the inbox server| |logChannelId|Server's default channel|Channel where to post links to closed threads and other alerts| |newThreadCategoryId|None|ID of the category where new modmail thread channels should be placed| +|relaySmallAttachmentsAsAttachments|false|Whether to relay small (<2MB) attachments from users as attachments rather than links in modmail threads|