V2 Docs

Temporary documentation for V2

What the bot does

Thread-Watcher keeps your selected threads active and un-archived. To start off, we will need to specify the threads that Thread-Watcher should keep active (hereafter "Watch").

We can do this on a thread-by-thread basis with the /watch command, which is easy if we have very few threads. If we have a lot of threads we want to watch, we can use the /batch command. This command allows us to watch all threads within a channel or all channels.

Now, to make sure everything worked, we can use the /list command to see the threads we just watched. Great, we're done! :D Now all we need to do is sit back and relax while Thread-Watcher takes care of our threads.

Commands

/watch

The watch command can be used to toggle whether or not a thread is watched

Option Name
Required
Options
Description
Default

thread

any thread

the thread you want to watch

the thread the command is ran in

/batch

The batch command can be used to set the watch state of multiple threads within a parent channel or category with options for selective filtering

Option Name
Required
Options
Description
Default

action

watch, unwatch, toggle, nothing

what you want to do to the threads contained in the targeted channel.

watch-new

True, False

If you want the bot to automatically watch future threads in the targeted channel

False

parent

any channel that can hold threads and categories

the channel you want to action threads in

the channel the command is ran in

advanced

True, False

if you want to selectively action threads depending on filters

False

Advanced Filtering

By setting advanced to True you will be given access to a filtering menu which allows you to conditionally action threads within the targeted channel. If watch-new is selected, these filters will apply to the channel monitor as well. Only new threads matching the filters will be automatically watched.

  • Roles - By selecting roles, only threads started by users having any one of these roles will be watched.

  • Tags - By selecting tags (where applicable), only threads which have any of these tags will be watched.

  • Pattern - By selecting a pattern, only threads which name match the selected pattern will be watched.

Pattern Rules

Patterns allow 2 "operators", ! and *

the * operator is what's refereed to as a wildcard which means it'll match any character and any number of times.

the ! operator can be placed in the beginning of the pattern to "reverse" what the pattern does.

Example Patterns

  • help-* will match any thread beginning with help-

  • !help-* will match any thread NOT beginning with help-

/list

the list command is used to show what threads are watched or what channels are monitored for creation of new threads

Option Name
Required
Options
Description
Default

show

threads, channels

what you want to see. Either watched threads or channels where threads will be watched automatically

threads

public

True, False

Whether or not you want the returned list of items to be shown publicly (to everyone who can see the channel) or privately (ephemeral message only you can see)

False

/channel add

Add a channel monitor. Any threads created within this channel will be automatically watched

/channel remove

Removes a channel monitor

Known Issues

The current codebase has a few known issues still plaguing it. These will be fixed when the rewrite gets deployed.

Newly watched threads disappearing

You might notice threads disappearing even though they are watched by the bot. You might think that's counterproductive to the supposed function of the bot. You'd be correct.

I understand the frustration and inconvenience this might cause and assure you it'll be gone when the rewrite is deployed. However, the issue is only temporary and fixes itself with time (usually about a week). You will notice the thread popping up again and after that it'll stay active properly.

Commands crashing

the codebase is quite a mess and crashes are not infrequent unfortunately. I'm hard at work fixing these issues for the rewrite

Last updated

Was this helpful?