engineering
/
ramirez
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README and CHANGELOG with info about the attachment relaying option

master
Dragory 2018-02-18 20:06:40 +02:00
parent 8a77bf1849
commit 223c196b95
2 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -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

6
README.md
View File

@ -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|