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

Update README and CHANGELOG for v2.20.0

master
Dragory 2019-03-28 05:12:02 +02:00
parent 2a20d9fdaa
commit ecbebff801
2 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CHANGELOG.md
View File

@ -1,5 +1,12 @@
# Changelog # Changelog
## 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 ## v2.19.0
* Add `attachmentStorage` option to control where attachments are saved. Currently supported: * 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 * `"local"` (default) - Same as before: attachments are saved locally on the machine running the bot and served through the bot's web server

3
README.md
View File

@ -72,6 +72,9 @@ These go in `config.json`. See also `config.example.json`.
|attachmentStorage|"local"|Controls where sent/received attachments are saved.<br><br>**"local"** - Files are saved locally on the machine running the bot<br>**"discord"** - Files are saved as attachments on a special channel on the inbox server. Requires `attachmentStorageChannelId` to be set.| |attachmentStorage|"local"|Controls where sent/received attachments are saved.<br><br>**"local"** - Files are saved locally on the machine running the bot<br>**"discord"** - Files are saved as attachments on a special channel on the inbox server. Requires `attachmentStorageChannelId` to be set.|
|attachmentStorageChannelId|null|When using "discord" attachment storage, the id of the channel on the inbox server where attachments should be saved| |attachmentStorageChannelId|null|When using "discord" attachment storage, the id of the channel on the inbox server where attachments should be saved|
|botMentionResponse|None|If set, the bot auto-responds to bot mentions with this message. Allows `{userMention}` to be added to mention the user who mentioned the bot.| |botMentionResponse|None|If set, the bot auto-responds to bot mentions with this message. Allows `{userMention}` to be added to mention the user who mentioned the bot.|
|categoryAutomation|{}|Various ways of automating thread categories on the inbox server. **Note that the options below with a dot in the name are object properties for `categoryAutomation`.**|
|categoryAutomation.newThread|None|Same as `newThreadCategoryId`. Specifies a category to open all new threads in. Also functions as a fallback for `categoryAutomation.newThreadFromGuild`.|
|categoryAutomation.newThreadFromGuild|None|Allows you to open threads in specific categories based on which guild the user is messaging the bot from. The value is an object with guild ids as the keys and category ids as the values.|
|closeMessage|None|The bot's message to the user when the thread is closed| |closeMessage|None|The bot's message to the user when the thread is closed|
|enableGreeting|false|Set to true to send a welcome message to new main guild members. Requires `mainGuildId` to be set.| |enableGreeting|false|Set to true to send a welcome message to new main guild members. Requires `mainGuildId` to be set.|
|greetingAttachment|None|Path to an image or other attachment to send along with the greeting| |greetingAttachment|None|Path to an image or other attachment to send along with the greeting|