configuring the bot
this bot offers subreddit customizations that can be made. actions that are taken are very customizable, offering a lot of power and granularity to the bot's ability. the default configuration is fine for most subreddits, but this offer is there. the configuration format is JSON, although there may be potential support for YAML configuration down the road.
the options, values, and some notes are below. all number ranges are inclusive (i.e. if it says between 0 and 10, then both 0 and 10 are allowed, as well as any number in between). if the value is null (without quotes), then it will have the same effect as being unset. if a value is required, it cannot be null.
if the bot cannot read from the wiki page, the bot will use the global defaults for all values. if a value doesn't exist, you can add it. read the notes for more information on how to use each option.
config version 1
| option | type | default value | allowed values if set | required? | notes |
|---|---|---|---|---|---|
version | Integer | 1 | the value 1 | yes | do not change this value. this value is required and is automatically generated. |
options | SubredditOptionSet | the global option set | a valid option set | no | see the "SubredditOptionSet" information below for more information. |
SubredditOptionSet
| option | type | default value | allowed values if set | required? | notes |
|---|---|---|---|---|---|
enabled | Boolean | true | true or false | no | if this value is false, the bot will not take actions on any post or comment in this subreddit. this overrides the scanPosts and scanComments options if false. |
scanPosts | Boolean | true | true or false | no | if this value is false, the bot will not look at posts |
scanComments | Boolean | true | true or false | no | if this value is false, the bot will not look at comments |
banNote | String | ""spam: BotTerminator banned" | 100 or less characters | no | ban notes are trimmed of excess whitespace. does not apply if bans are disabled |
banMessage | String | "BotTerminator banned" | 300 or less characters | no | ban messages are trimmed of excess whitespace. does not apply if bans are disabled. |
banDuration | Integer | 0 | between -1 and 999 | yes | if this value is 0, then the ban issued is permanent. if this value is -1, then bans will not be applied. other actions (such as removals) may still be applied. |
ignoredUsers | List of Strings | ["AutoModerator", "reddit"] | any list of strings | no | the global ignore list (see the default value) is added to the subreddit ignore list rather than replacing it. |
actionedUserTypes | List of Strings | ["replybot"] | any of bot, accountfarmer, human, moderationbot, servicebot, singlesubbot, replybot | no | unlike the previous value, any non-null value will replace the default value. an empty list will have the same effect as setting enabled to false. |
removalType | RemovalType | Spam | one of None, Spam, Remove | yes | the action to take when the bot finds a post on a subreddit on the account list with that falls into any of the groups defined by actionedUserTypes. |
FAQ
how do I get the bot to recognize my changes? we look for changes automatically, so you shouldn't need to do anything at all. if it's been about 30 minutes and there isn't an update please send a modmail.