Online and Build Status

Thermostat

Thermostat is a bot created for Discord servers, in order to help out server owners who do not have the time or simply want their channel slowmode to be adjusted automatically. Staff teams should be focused on moderating the server and the people in it. By getting Thermostat in your server, you get rid of all of the stress that keeping an adequate slowmode might bring.

Motivation

This bot was created with larger servers in mind, in order to keep the chat's speed readable and under control, while also defending against large raids & spam attacks.

Features & How To Use

What makes Thermostat special is the fact that it controls Discord slowmode in a dynamic way, calculating the needed slowmode for a channel dependent on the number of incoming messages in a unit of time. It comes with easy set up, which is only a few commands. That's it! You set it, and forget it. Thermostat does not require continuous changes or maintenance.
All you have to do is get started with Thermostat is:

Invite Thermostat to your server.
Set up your server prefix by sending the @Thermostat prefix command.
Monitor the channels you need with `prefix`monitor `channels/categories`.
Set up the maximum slowmode upper bound for your channels using `prefix`setmaximum `channels/categories`.
Edit the channel sensitivity with `prefix`sensitivity `channels/categories` `sensitivity`.
Empower your server and visualize your most active channels with `prefix`chart!

Note: `prefix`, and `channels/categories` are variables that should be replaced as per your need. For example, if your prefix is th! and you're trying to monitor a channel called "#general", you would type th!monitor #general.

You can find more about these commands in our wiki.

Troubleshooting

The most common issue with all bots on Discord is permission errors. If a bot is not working properly, the most likely cause is a permission issue. If you need a guide to take you through that, Discord has a great article all about it.

Thermostat currently needs these permissions in a channel to function correctly:
Permission - Purpose

Manage Channels - Adjust Slowmode
Read Messages - Receive commands
Send Messages - Show command output
Manage Messages - Update command output
Embed Links - Neatly organize messages
Read Message History - Receive commands
Add Reactions - Reaction UI menus
Attach Files - Uploading chart images

The bot is going to react accordingly to the permissions it is missing. Please make sure that before you submit an issue, you have validated that Thermostat has all needed permissions in the specific channel you're trying to use it in. If you still have problems, join our support server.

Current Dependencies

License

The license used allows:

Using the code provided in this repository for commercial use.
Modifying the code provided in this repo.
Privately using the code.

However, you must:

Distribute the code under the same license.
State which snippets you have modified.
Disclose the source of the code.