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

Update README and CHANGELOG with recent changes

master
Dragory 2018-04-21 15:48:38 +03:00
parent 319f6571bc
commit b31639dc2e
2 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CHANGELOG.md
View File

@ -1,5 +1,16 @@
# Changelog
## 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

12
README.md
View File

@ -34,7 +34,8 @@ See [CHANGELOG.md](CHANGELOG.md)
`!edit_snippet <shortcut> <text>` Edits an existing snippet (alias `!es`)
`!delete_snippet <shortcut>` Deletes the specified snippet (alias `!ds`)
`!snippets` Lists all available snippets
`!version` Print the version of the bot you're running
`!version` Print the version of the bot you're running
`!newthread <user>` Opens a new thread with the specified user
##### Inside a modmail thread
`!reply <text>` Sends a reply to the user in the format "(Role) User: text" (alias `!r`)
@ -45,9 +46,10 @@ See [CHANGELOG.md](CHANGELOG.md)
`!unblock` Unblocks the user from using modmail
`!!shortcut` Reply with a snippet. Replace `shortcut` with the snippet's actual shortcut.
`!move <category>` If `allowMove` is enabled, moves the thread channel to the specified category
`!loglink` Shows the link to the current thread's log
`!suspend` Suspend a thread. The thread will act as closed and not receive any messages until unsuspended.
`!unsuspend` Unsuspend a thread
`!loglink` Shows the link to the current thread's log
`!suspend` Suspend a thread. The thread will act as closed and not receive any messages until unsuspended.
`!unsuspend` Unsuspend a thread
`!id` Prints the user's ID
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
@ -59,7 +61,7 @@ These go in `config.json`. See also `config.example.json`.
|token|None|**Required!** The bot user's token|
|mailGuildId|None|**Required!** The inbox server's ID|
|logChannelId|None|**Required!** Channel where to post log links to closed threads and other alerts|
|mainGuildId|None|ID of the main server where people contact the bot from, used for e.g. displaying users' nicknames|
|mainGuildId|None|ID (or array of IDs) of the main server where people contact the bot from. Used for displaying users' nicknames and join dates, and catching bot pings.|
|prefix|"!"|Prefix for bot commands|
|status|"Message me for help"|The bot's "Playing" text|
|responseMessage|"Thank you for your message! Our mod team will reply to you here as soon as possible."|The bot's response to DMs that start a new thread|