For instructions on how to update the bot, see ✨ Updating the bot
- Fixed inline replies not working with alwaysReply or snippets
- Fixed buggy note display in thread header
- The logChannel message for a closed thread now also contains a summary of the number of messages in that thread (by LilyWonhalf)
- 3 new plugin hooks (by LilyWonhalf):
afterNewMessageReceived
afterThreadCloseScheduled
afterThreadCloseScheduleCanceled
- All plugin message formatters can now be asynchronous
- Environment variables for config can now also be supplied by a
.env
file (by Eight8-7020) - Fixed bug that broke message formatters (including the embeds plugin) in 3.5.0
- Fixed ERR_PACKAGE_PATH_NOT_EXPORTED error on Node.js 17
- Updated "engines" values in package.json
- Updated outdated transitive dependencies
New features
- Added support for user notes (by bycop)
- Added support for streaming status (by GeekCornerGH)
- Added
updateMessagesLive
option to show user edits/deletions directly in the original message (by cAttte) - Added option to remove ("break") markdown formatting in names within a thread (enabled by default) (by DarkView)
- Added options to send a message to the user when they are blocked (by DarkView + Dragory)
blockMessage
is sent to the user when they are blockedtimedBlockMessage
is sent to the user when they are blocked temporarilyunblockMessage
is sent to the user when they are unblockedtimedUnblockMessage
is sent to the user when they are scheduled to be unblocked laterblockedReply
is sent to the user if they try to message the bot while blocked
- Added ban/unban detection to user leave/join notifications (by DarkView)
- Added functionality to recover DMs sent while the bot is offline (by DarkView)
- Added support for sending/receiving inline replies
Plugins
- New plugin hook:
beforeNewMessageReceived
(by LilyWonhalf) - Added
channelName
tobeforeNewThreadHook
'sopts
to allow plugins to change the name of the modmail channel before it's created (by LilyWonhalf)
Fixes, tweaks, and backend changes
- Updated to Eris 0.17.0
- Added custom text if user has no logs when using !logs (by YetAnotherConnor)
!alert
,!id
,!loglink
, and!role
can now be used in suspended threads- Fixed bug where the first staff reply would say
null
instead of1
(by dtslubbersen) - Fixed
mentionRole
config option not allowing multiple values (by Teekeks) - Fixed user pings not working when using
{userMention}
inbotMentionResponse
(by Rewish497) - Fixed error in database migrations with a large database (by PichotM)
- Fixed links in documentation to point to discord.com rather than discordapp.com (by almeidx)
- Fixed crash if categoryAutomation.newThread was not set (by DarkView)
- Fixed crash if a message with only the snippet prefix is posted (by DarkView)
- Fixed crash when trying to report configuration issues (by DarkView)
- Fixed crash when trying to create a channel with a disallowed name on a server in Server Discovery (by Deldaflyer)
- Fixed edited content for older messages not showing (by Dragory)
- Fixed
npm
requiring Git with v3.4.0
- Updated Eris to fix crash with text in voice channels
- Updated outdated dependencies
- This also adds support for Node.js 16
- Fix database warning when updating to v3.3.1 or higher
- Fix crash when a user joins or leaves a stage channel
- Fix global moderator display role overrides (i.e.
!role
used outside of a thread) not working
Breaking changes:
- The default value for
inboxServerPermission
is nowmanageMessages
- This means that after updating, if you haven't set
inboxServerPermission
in yourconfig.ini
, only those members with the "Manage Messages" permission on the inbox server will be able to use the bot's commands
- This means that after updating, if you haven't set
- The default value for
mentionRole
is nownone
- To turn
@here
pings back on for new threads, setmentionRole = here
in yourconfig.ini
- To turn
General changes:
- New option:
showResponseMessageInThreadChannel
- Controls whether the bot's response message is shown in the thread channel
- Bot and Node.js version is now shown on bot start-up
!close silent
can now also be used with!close -silent
and!close -s
(#528 by @SnowyLuma)!close cancel
can now also be used with!close -cancel
and!close -c
config.example.ini
now contains several common options by default- When starting the bot via command line, you can now specify which config file to load with the
--config
/-c
CLI option- E.g.
npm start -- -c my-other-config.ini
(note the--
betweennpm start
and the option)
- E.g.
- Updated bot dependencies
Plugins:
- Plugins are now installed before connecting to the Discord Gateway
- Fix GitHub-based NPM plugins requiring Git to be installed to work
- If you need to install GitHub-based plugins with Git after this change, set
useGitForGitHubPlugins = on
in your config
- If you need to install GitHub-based plugins with Git after this change, set
- Plugin installation errors are no longer truncated
General changes:
- Updated to Eris 0.14.0, which changes the API url used to
discord.com
instead ofdiscordapp.com
- API calls to
discordapp.com
are being phased out on Nov 7, 2020 - This means that bot versions prior to v3.2.0 might stop working on Nov 7, 2020
- API calls to
- New options:
allowBlock
,allowSuspend
,allowSnippets
(#498 by @lirolake)- These all default to
on
- These all default to
- Improved error messages and error handling
- Removes at least one instance of ECONNRESET errors
- Fixed issue where NPM plugins would not install on Windows
- Fixed issue where mentions by the bot were not working in certain situations (#496 by @DarkView)
- Fixed issue where long system messages (primarily from plugins) would not get chunked properly and would throw an error instead
Plugins:
- Make sure to check the Eris 0.14.0 changelog for any changes that might affect your plugins
- The
attachments
object now includes a newsaveAttachment()
function to save arbitrary attachments using the bot'sattachmentStorage
- Fixed the
ignoreHooks
option forthreads.createNewThreadForUser()
not working - Fixed
!newthread
throwing an error if a plugin cancels thread creation in thebeforeNewThread
hook
- Each thread is now assigned a number, increasing by 1 each thread. This can be used in commands like
!log
in place of the full thread ID. - New option:
autoAlert
- When enabled, the last moderator to reply to a modmail thread will be automatically alerted when the thread gets a new reply
- Auto-alert kicks in after a small delay after the reply to prevent alerts in the middle of an ongoing conversation. This delay is set by the option
autoAlertDelay
.
- New option:
pinThreadHeader
- When enabled, the bot will automatically pin the "thread header" message that contains the user's details
!thread
is now an alias for!log
/!loglink
- Fix some bugs with the
mentionRole
option mentionRole = off
now behaves the same asmentionRole = none
- Fixed snippet previews (via
!snippet snippet_name_here
) sometimes cutting off the first word (#491 by @Gugu7264) - When calling
threads.createNewThreadForUser()
, plugins can now specifymentionRole
as one of the options to override the default mentionRole config option value for the new thread
- Fix inline snippets only working once per reply
- Fix
npm ci
andstart.bat
failing when Git is not installed
- Fix local attachments not being accessible through the bot's links
This changelog also includes changes from v2.31.0-beta.1 and v2.31.0-beta.2
General changes:
- BREAKING CHANGE: Logs from Modmail versions prior to Feb 2018 are no longer converted automatically
- To update from a Modmail version from before Feb 2018, update to
v2.30.1
and run the bot once first. Then you can update to version v3.0.0 and later.
- To update from a Modmail version from before Feb 2018, update to
- BREAKING CHANGE: Added support for Node.js 13 and 14, dropped support for Node.js 10 and 11
- The supported versions are now 12, 13, and 14
- BREAKING CHANGE: The bot now requests the necessary Gateway Intents
- This includes the privileged "Server Members Intent", which is used for server greetings/welcome messages.
This means that you need to turn on "Server Members Intent" on the bot's page on the Discord Developer Portal.
- This includes the privileged "Server Members Intent", which is used for server greetings/welcome messages.
- Added support for editing and deleting staff replies via new
!edit
and!delete
commands- This is enabled by default
- This can be disabled with the
allowStaffEdit
andallowStaffDelete
options - Only the staff member who sent the reply can edit/delete it
- Renamed the following options. Old names are still supported as aliases, so old config files won't break.
mainGuildId
=>mainServerId
mailGuildId
=>inboxServerId
categoryAutomation.newThreadFromGuild
=>categoryAutomation.newThreadFromServer
guildGreetings
=>serverGreetings
- Moderators can now set the role they'd like to be displayed with their replies ("display role") by default and on a per-thread basis by using
!role
- Moderators can only choose roles they currently have
- You can view your current display role by using
!role
- If you're in a modmail thread, this will show your display role for that thread
- If you're not in a modmail thread, this will show your default display role
- You can set the display role by using
!role <role name>
, e.g.!role Interviewer
- If you're in a modmail thread, this will set your display role for that thread
- If you're not in a modmail thread, this will set your default display role
- You can reset the display role by using
!role reset
- If you're in a modmail thread, this will reset your display role for that thread to the default
- If you're not in a modmail thread, this will reset your default display role
- This feature can be disabled by setting
allowChangingDisplayRole = off
- New option:
fallbackRoleName
- Sets the role name to display in moderator replies if the moderator doesn't have a hoisted role
- New option
logStorage
- Allows changing how logs are stored
- Possible values are
local
(default),attachment
, andnone
- New default attachment storage option:
original
- This option simply links the original attachment and does not rehost it in any way
- New option
reactOnSeen
(#398 by @Eegras)- When enabled, the bot will react to user DMs with a checkmark when they have been received
- The reaction emoji can be customized with the
reactOnSeenEmoji
option
- New option
createThreadOnMention
(#397 by @dopeghoti)- When enabled, a new modmail thread will be created whenever a user mentions/pings the bot on the main server
- As with
pingOnBotMention
, staff members are automatically ignored
- New option
statusType
- Allows changing the bot's status type between "Playing", "Watching", "Listening"
- Possible values are
playing
(default),watching
,listening
- New option
anonymizeChannelName
(#457 by @funkyhippo)- Off by default. When enabled, instead of using the user's name as the channel name, uses a random channel name instead.
- Useful on single-server setups where people with modified clients can see the names of even hidden channels
- New option
updateNotificationsForBetaVersions
- Off by default. When enabled, also shows update notifications for beta versions.
- By default, update notifications are only shown for stable releases
- Snippets can now be included within messages by wrapping the snippet name in curly braces
- E.g.
!r Hello! {{rules}}
to include the snippetrules
in the place of{{rules}}
- The symbols used can be changed with the
inlineSnippetStart
andinlineSnippetEnd
options - This feature can be disabled by setting
allowInlineSnippets = off
in your config - By default, the bot will refuse to send a reply with an unknown inline snippet. To disable this behavior, set
errorOnUnknownInlineSnippet = off
.
- E.g.
mentionRole
can now be set tonone
- Removed the long-deprecated
logDir
option - The bot now notifies if the user leaves/joins the server (#437 by @DarkView)
- Replies are now limited in length to the Discord message limit (including the moderator name and role in the DM sent to the user)
- This is to fix issues with
!edit
and!delete
when a reply spanned multiple messages
- This is to fix issues with
- DM channel and message IDs are now stored
- Use
!loglink -v
to view these in logs - Use
!dm_channel_id
in an inbox thread to view the DM channel ID - DM channel and message IDs are primarily useful for Discord T&S reports
- Use
- Unless
fallbackRoleName
is set, anonymous replies without a role will no longer display "Moderator:" at the beginning of the message - Plugins can now also be installed from NPM modules
- Example:
plugins[] = npm:some-plugin-package
- Example:
- "Connection reset by peer" error (code 1006) is now handled gracefully in the background and no longer crashes the bot
- Multiple people can now sign up for reply alerts (
!alert
) simultaneously (#373 by @DarkView) - The bot now displays a note if the user sent an application invite, e.g. an invite to listen along on Spotify
- The bot now displays a note if the user sent a sticker, including the sticker's name
- Log formatting is now more consistent and easier to parse with automated tools
- Messages in modmail threads by other bots are no longer ignored, and are displayed in logs
- Added official support for MySQL databases. Refer to the documentation on
dbType
for more details.- This change also means the following options are no longer supported:
dbDir
(usesqliteOptions.filename
to specify the database file instead)knex
(seedbType
documentation for more details)
- This change also means the following options are no longer supported:
- System messages sent to the user, such as
responseMessage
andcloseMessage
, are now shown in the thread channel - Fixed
!edit_snippet
crashing the bot when leaving the new snippet text empty - Fix crash when using
!newthread
with the bot's own ID (fixes #452) - Fix occasional bug with expiring blocks where the bot would send the expiry message multiple times
- Fix bug with long messages being cut off and only the last part being shown in the thread (most evident in long DMs and e.g. !edit notifications of long messages)
- Fix messages containing only a large number (e.g. an ID) rounding the number
- Several common errors are now handled silently in the background, such as "Connection reset by peer"
Plugins:
- Added support for replacing default message formatting in threads, DMs, and logs
- Added support for hooks. Hooks can be used to run custom plugin code before/after specific moments.
- Two hooks are initially available:
beforeNewThread
andafterThreadClose
- See plugin documentation for mode details
- Two hooks are initially available:
- If your plugin requires special gateway intents, use the new
extraIntents
config option - Plugins can now access the bot's web server via a new
webserver
property in plugin arguments - Plugins can now store metadata in threads and thread messages via new
setMetadataValue
andgetMetadataValue
functions onThread
andThreadMessage
objects - Plugins can access the API for setting/getting moderator display roles via a new
displayRoles
property in plugin arguments - System messages now have a formatter
- The
beforeNewThread
hook's parameters now also include the original DM message object - Plugins can now access the
threads
module (viapluginApi.threads
) to create and fetch threads - Plugins can now access the
displayRoles
module (viapluginApi.displayRoles
) to get, set, and reset display role overrides for moderators, and to get the final role that will be displayed in moderator replies (by default or per-thread)
Internal/technical updates:
- Updated Eris to v0.13.3
- Updated several other dependencies
- New JSON Schema based config parser that validates each option and their types more strictly to prevent undefined behavior
- Database migrations are now stored under
src/
- Modmail now uses Express as its web server for logs/attachments
- Unhandled rejections are now handled the same as uncaught exceptions, and will crash the bot
This is a beta release, bugs are expected.
Please report any bugs you encounter by creating a GitHub issue!
General changes:
- BREAKING CHANGE: Logs from Modmail versions prior to Feb 2018 are no longer converted automatically
- To update from a Modmail version from before Feb 2018, update to
v2.30.1
and run the bot once first. Then you can update to later versions.
- To update from a Modmail version from before Feb 2018, update to
- New option
logStorage
- Allows changing how logs are stored
- Possible values are
local
(default),attachment
, andnone
- New option
statusType
- Allows changing the bot's status type between "Playing", "Watching", "Listening"
- Possible values are
playing
(default),watching
,listening
- New option
anonymizeChannelName
(#457 by @funkyhippo)- Off by default. When enabled, instead of using the user's name as the channel name, uses a random channel name instead.
- Useful on single-server setups where people with modified clients can see the names of even hidden channels
- New option
updateNotificationsForBetaVersions
- Off by default. When enabled, also shows update notifications for beta versions.
- By default, update notifications are only shown for stable releases
mentionRole
can now be set tonone
- The bot now notifies if the user leaves/joins the server (#437 by @DarkView)
- Fix crash when using
!newthread
with the bot's own ID (fixes #452)
Plugins:
- New hook:
afterThreadClose
- Called right after a thread is closed with the thread's id
- You can now add custom log storage types
Internal/technical updates:
- Database migrations are now stored under
src/
This is a beta release, bugs are expected.
Please report any bugs you encounter by creating a GitHub issue!
General changes:
- BREAKING CHANGE: Added support for Node.js 13 and 14, dropped support for Node.js 10 and 11
- The supported versions are now 12, 13, and 14
- BREAKING CHANGE: The bot now requests the necessary Gateway Intents
- This includes the privileged "Server Members Intent", which is used for server greetings/welcome messages.
This means that you need to turn on "Server Members Intent" on the bot's page on the Discord Developer Portal.
- This includes the privileged "Server Members Intent", which is used for server greetings/welcome messages.
- Renamed the following options. Old names are still supported as aliases, so old config files won't break.
mainGuildId
=>mainServerId
mailGuildId
=>inboxServerId
categoryAutomation.newThreadFromGuild
=>categoryAutomation.newThreadFromServer
guildGreetings
=>serverGreetings
- Added support for editing and deleting staff replies
- This is enabled by default
- This can be disabled with the
allowStaffEdit
andallowStaffDelete
options - Only the staff member who sent the reply can edit/delete it
- New option
reactOnSeen
(#398 by @Eegras)- When enabled, the bot will react to user DMs with a checkmark when they have been received
- The reaction emoji can be customized with the
reactOnSeenEmoji
option
- New option
createThreadOnMention
(#397 by @dopeghoti)- When enabled, a new modmail thread will be created whenever a user mentions/pings the bot on the main server
- As with
pingOnBotMention
, staff members are automatically ignored
- New default attachment storage option:
original
- This option simply links the original attachment and does not rehost it in any way
- DM channel and message IDs are now stored
- Use
!loglink -v
to view these in logs - Use
!dm_channel_id
in an inbox thread to view the DM channel ID - DM channel and message IDs are primarily useful for Discord T&S reports
- Use
- Multiple people can now sign up for reply alerts (
!alert
) simultaneously (#373 by @DarkView) - The bot now displays a note if the user sent an application invite, e.g. an invite to listen along on Spotify
- Log formatting is now more consistent and easier to parse with automated tools
- Messages in modmail threads by other bots are no longer ignored, and are displayed in logs
- Added official support for MySQL databases. Refer to the documentation on
dbType
for more details.- This change also means the following options are no longer supported:
dbDir
(usesqliteOptions.filename
to specify the database file instead)knex
(seedbType
documentation for more details)
- This change also means the following options are no longer supported:
- Removed the long-deprecated
logDir
option - Fixed
!edit_snippet
crashing the bot when leaving the new snippet text empty
Plugins:
- Added support for replacing default message formatting in threads, DMs, and logs
- Added support for hooks. Hooks can be used to run custom plugin code before/after specific moments.
- Initially only the
beforeNewThread
hook is available. See plugin documentation for more details.
- Initially only the
- If your plugin requires special gateway intents, use the new
extraIntents
config option - Some code reorganisation related to threads and thread messages. If you have a plugin that interacts with Thread or ThreadMessage objects, test them before running this update in production!
Internal/technical updates:
- Updated Eris to v0.13.3
- Updated several other dependencies
- New JSON Schema based config parser that validates each option and their types more strictly to prevent undefined behavior
- Fix crash with
responseMessage
andcloseMessage
introduced in v2.30.0 (#369)
- The following config options now also support multi-line values:
responseMessage
closeMessage
botMentionResponse
greetingMessage
accountAgeDeniedMessage
timeOnServerDeniedMessage
- When the bot is mentioned on the main server, the log message about this now also includes a link to the message (#319)
- Fix error when supplying all config values from env variables without a config file
- Fix crash in update checker if the repository value in package.json is set to a GitHub repository without releases (this only applies to forks)
- Fix boolean values in
config.ini
not being handled properly
- Default configuration format is now .ini
- Existing
config.json
files will continue to work and will not be deprecated - This makes the default configuration format for the bot much more approachable than JSON
- Existing
- Config values can now also be loaded from environment variables (see Configuration for more details)
- New rewritten instructions for setting up and using the bot
- New easy-to-use
start.bat
file for Windows - Update several package dependencies
- Fixed incompatibility with Node.js 10 versions prior to 10.9.0
- Fix error when saving attachments locally with
attachmentStorage
set to"local"
(default) when the bot's folder is on a different storage device than the system's temp folder - Add
attachments
object to the plugin API- This allows plugins to add new storage types via
attachments.addStorageType()
- See the Plugins section in the README for more details
- This allows plugins to add new storage types via
- The
syncPermissionsOnMove
option now defaults totrue
, which should be more intuitive - Plugins: Plugin functions are no longer called with 4 arguments. Instead, the function is called with 1 argument,
which is an object that contains the previous 4 values as properties:
bot
,knex
,config
,commands
. This will make it easier to scale the plugin system in the future with new features. You can see an updated example in the README.
- The bot now waits for the main server(s) and inbox server to become available before initializing. This is a potential fix to #335. This should have little to no effect on smaller servers.
- The bot status ("Playing") is now reapplied hourly since the status can sometimes disappear
- Fix regression introduced in v2.24.0 where line breaks would get turned to spaces in replies and snippets (#304)
- Replace the internal command handler with a new one. This should be fairly thoroughly tested, but please report any issues you encounter!
- Plugins are now called with a fourth parameter that allows you to easily add specific types of commands
- Due to the command handler change, any calls to
bot.registerCommand
should be replaced with the new system
- Due to the command handler change, any calls to
- Switch to the new stable version of Eris (0.10.0) instead of the dev version
- Update Node.js version check at startup to require Node.js 10
- Updated required Node.js version in .nvmrc and README (v10 is now the minimum)
- Add update notifications. The bot will check for new versions every 12 hours and notify moderators at the top of new
modmail threads when there are new versions available. Can be disabled by setting the
updateNotifications
option tofalse
. New available versions are also shown in!version
.- If you have forked the repository and want to check for updates in your own repository instead,
change the
repository
value inpackage.json
- If you have forked the repository and want to check for updates in your own repository instead,
change the
- Add basic support for plugins. See the Plugins section in README for more information.
- Add support for snippet arguments. To use these, put {1}, {2}, etc. in the snippet text and they will be replaced by the given arguments when using the snippet.
- Add support for multiple
mentionRole
config option values in an array - Add
commandAliases
config option to set custom command aliases - Add support for timed blocks. Simply specify the duration as the last argument in
!block
or!unblock
. - Add pagination to
!logs
- Add
guildGreetings
option to allow configuring greeting messages on a per-server basis - Add
rolesInThreadHeader
option to show the user's roles in the modmail thread's header
- Fix crash caused by Nitro Boosting notifications
- Update Eris to fix crashes with news channels and nitro boosting
- "Account age" and "time on server" requirements are now ignored when using
!newthread
- Add
requiredTimeOnServer
andtimeOnServerDeniedMessage
config options to restrict modmail from users who have just joined the server. Thanks @reboxer (#270)!
- Add
categoryAutomation
option to automate thread categories. Currently supported sub-options:newThread
- same asnewThreadCategoryId
, the default category for new threadsnewThreadFromGuild
- 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
- 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"discord"
- Attachments are saved on a special Discord channel specified by theattachmentStorageChannelId
option
- Add
syncPermissionsOnMove
option. When enabled, thread channel permissions are synced with the category when the thread is moved with!move
. - Add support for scheduling
!suspend
. Works the same way as with!close
, just specify the time after the command. Can be cancelled with!suspend cancel
. - Scheduled
!close
can now be silent - just addsilent
as an argument to the command before or after the schedule time - The schedule time format for
!close
is now stricter and times with whitespace (e.g.2 h 30 m
) no longer work. Use e.g.2h30m
instead. !loglink
can now be used in suspended threads- User can now be mentioned in
botMentionResponse
by adding{userMention}
to the response text. Thanks @reboxer (#225)! - Fixed a small mistake in README, thanks @GabrielLewis2 (#226)!
- Add
silent
option to!close
(e.g.!close silent
) to close threads without sending the specifiedcloseMessage
- Update some package versions (may help with sqlite3 install issues)
- Add
mentionUserInThreadHeader
option. When set totrue
, mentions the thread's user in the thread header. Fixes #152. - Add
botMentionResponse
option. If set, the bot auto-responds to bot mentions with this message. Fixes #143. - Fix member info sometimes missing in thread header. Thanks @Akhawais (#136)!
- Add support for role and user IDs in inboxServerPermission instead of just permission names
- Allow specifying multiple values (an array) for inboxServerPermission. Members will be considered "staff" if they pass any of the values.
- Update Eris to 0.9.0, Knex to 0.15.2
- Add support for sending anonymous snippets. By default, you can do this by using
!!!
instead of!!
. Fixes #82. - Add
snippetPrefixAnon
option - Add
allowUserClose
option. When set totrue
, users can use the close command to close threads by themselves. - Fix
allowMove
missing from README. Thanks @AndreasGassmann (#126)!
- Add support for a .js config file (export config with
module.exports
)
- Update several other packages as well
- Update
node-sqlite3
dependency to hopefully fix installation issues on some setups
- Add
smallAttachmentLimit
config option to control the max size of attachments forwarded byrelaySmallAttachmentsAsAttachments
- Fix crash when
closeMessage
failed to send - Handle webserver errors gracefully
- Don't alert for main server pings if the pinger is a bot
- Changed
requiredAccountAge
to be in hours instead of days
- Added
requiredAccountAge
andaccountAgeDeniedMessage
options for restricting how new accounts can message modmail
- Added
closeMessage
option. This option can be used to send a message to the user when their modmail thread is closed. - Documented
pingOnBotMention
option
- Fixed greetings not being sent since multi-server support was added in 2.9.0
- Config files are now parsed using JSON5, allowing you to use comments, trailing commas, and other neat things in your config.json
- When using multiple main guilds, the originating guild name is now always included at the top of the thread (if possible). Previously, if the user that messaged modmail was on only one of the guilds, the guild name would not be shown at the top.
- Fixed crash when a user edited a message in their DMs with modmail without an open thread
- Small fixes to category name matching when using
!move
- Fixed crash when the bot was unable to send an auto-response to a user
- Added option
pingOnBotMention
(defaults totrue
) that allows you to control whether staff are pinged when the bot is mentioned - Long messages are now chunked so they don't fail to send due to added length from e.g. user name
- Changed timed close default unit from seconds to minutes.
This means that doing e.g.
!close 30
now closes the thread in 30 minutes, not seconds.
- Added
!alert
Using!alert
in a modmail thread will ping you the next time the thread gets a new reply. Use!alert cancel
to cancel.
- If using multiple main guilds, the originating server is now specified in bot mention notifications
- 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
- Added a
!version
command for checking the version of the bot you're running
- Split more code from main.js to individual module files
- Warn the user if new dependencies haven't been installed
!close
now supportsd
for days in the delay!close
is now stricter about the time format
- Commands used in inbox threads are now saved in logs again
- Moved more of the code to individual plugin files
- Fix errors on first run after upgrading to v2.2.0
- Various other fixes
- Add thread suspending. A modmail thread can now be suspended with
!suspend
. Suspended threads will function as closed until unsuspended with!unsuspend
.
- Auto-close threads if their modmail channel is deleted
- Fixed incorrect default value for
mentionRole
(wasnull
, should've been"here"
)
- Added
mentionRole
configuration option (#59). This option can be used to set the role that is pinged when new threads are created or the bot is mentioned. See README for more details.
- Added the ability to schedule a thread to close by specifying a time after
!close
, e.g.!close 1h
. The scheduling is cancelled if a new message is sent to or received from the user.
- Added typing proxy (#48):
- If the
typingProxy
config option is enabled, any time a user is typing to modmail in their DMs, the modmail thread will show the bot as "typing" - If the
typingProxyReverse
config option is enabled, any time a moderator is typing in a modmail thread, the user will see the bot "typing" in their DMs
- If the
- The link to the current thread's log is no longer posted to the top of the thread. Use
!loglink
instead.
- 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 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 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 theallowMove
config option, disabled by default.
- Added
newThreadCategoryId
option. This option can be set to a category ID to place all new threads in that category.
- Fixed crash when the bot was unable to find or create a modmail thread
- Reduced error log spam in case of network errors from Eris
- Fixed unintended error when a message was ignored due to an "accidental thread" word
- Added
logChannelId
option - Some code clean-up. Please open an issue if you encounter any bugs!
- The bot now throws an error for unknown options in
config.json
(assuming they're typos) and tells you if you haven't configured the token or mail guild id.
- Fixed user nicknames not showing in new threads
- The "manageRoles" permission is no longer required to use commands on the inbox server.
This can be configured with theinboxServerPermission
config option.
- Commands are now case-insensitive (so !close, !Close, and !CLOSE all work)
- The before/after prefixes in edit notifications are now the same length, making it easier to spot the edited part
- Non-ASCII names should now result in better channel names (not just "unknown")
- Identical edits are now ignored
- New thread notification (with @ here ping) is now posted in the thread instead of the inbox server default channel
- Thread close notifications no longer ping the user who closed the thread
- Received attachments are now only linked once the bot has saved them (should fix embeds)
- Replies now use your nickname, if any
- Several messages are now ignored for thread creation ("ok", "thanks", and similar)
- Logs from !logs are now sorted in descending order (newest first)
More info is now available at the beginning of modmail threads.
Major rewrite. Includes anonymous replies (!ar), stability improvements, and server greeting feature.