Skip to content

Commit

Permalink
Update documentation to version 1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
DarkView committed Mar 6, 2021
1 parent c0e2eec commit b0bde4b
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 4 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
## Version 1.3
- New command: `rtRefresh`
Allows any owner to instantly refresh all reactions

The bot now removes and re-applies all reactions it manages automatically every 30 minutes and on restart.
In case you want to immediately refresh, you can use the `rtRefresh` command which advances the next check so it happens right away.

Please read the [command documentation](https://github.com/MMPlugins/ReactionThreads#commands) to learn how to use this new command!

## Version 1.2
- New command: `rtList`
Allows any owner to list all reactions the bot currently has registered
Expand Down
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## A plugin for [Dragory's ModMail](https://github.com/dragory/modmailbot) that allows users to open threads with reactions
**Currently on Version 1.2**
**Currently on Version 1.3**
A full [changelog can be found here](https://github.com/MMPlugins/ReactionThreads/blob/main/CHANGELOG.md).
Plugin written and maintained by [DarkView](https://github.com/DarkView) (Dark#1010 on Discord)

Expand All @@ -13,6 +13,9 @@ Table of Contents:
- [Commands](#commands)
- [Adding/Registering a reaction](#addingregistering-a-reaction)
- [Removing/De-Registering a reaction](#removingde-registering-a-reaction)
- [Adding/Removing/Displaying custom responses](#addingremovingdisplaying-custom-responses)
- [Listing all reactions](#listing-all-reactions)
- [Refreshing all reactions](#refreshing-all-reactions)

## Setup
Make sure you are running at least v3.3.0 of Modmail.
Expand Down Expand Up @@ -73,9 +76,14 @@ If you want to completely remove a response, pass one of the following without a
This command and its functionality was made by [YetAnotherConnor](https://github.com/YetAnotherConnor).

### Listing all reactions
Signature: Signature: `!rtList [Any ID]`
Signature: `!rtList [Any ID]`
This will return a list of all current reactions that match the ID filter if one is given.
- `Any ID` can be any of the IDs available for reactions: `Channel ID`, `Message ID` and `Category ID`. If this parameter is passed, only reactions that are on that message or in that channel etc. get listed.
- `Any ID` can be any of the IDs available for reactions: `Channel ID`, `Message ID` and `Category ID`. If this parameter is passed, only reactions that are on that message or in that channel etc. get listed.

### Refreshing all reactions
Signature: `!rtRefresh`
This will refresh all reactions this plugin manages.
This happens every 30 minutes automatically, and this command advances the next refresh to happen immediately.


Table of Contents:
Expand All @@ -89,6 +97,7 @@ Table of Contents:
- [Adding/Registering a reaction](#addingregistering-a-reaction)
- [Removing/De-Registering a reaction](#removingde-registering-a-reaction)
- [Adding/Removing/Displaying custom responses](#addingremovingdisplaying-custom-responses)
- [Listing all reactions](#listing-all-reactions)
- [Listing all reactions](#listing-all-reactions)
- [Refreshing all reactions](#refreshing-all-reactions)

Plugin written and maintained by [DarkView](https://github.com/DarkView) (Dark#1010 on Discord)
1 change: 1 addition & 0 deletions reactionThreads.js
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,7 @@ module.exports = function ({ bot, config, commands, knex, threads }) {
const refreshReactions = async (msg = null) => {
clearTimeout(refreshTimeout);
if (msg) {
if (!isOwner(msg)) return;
msg = await msg.channel.createMessage(`Refreshing all reactions...`);
}

Expand Down

0 comments on commit b0bde4b

Please sign in to comment.