Posts
Wiki
Basic Configuration
Floodgates reads configs in YAML, which is the same format used by automod, so if you know how automod-esque syntax works, you know how YAML works. If not, here are a few tutorials that might help: "YAML Syntax", "YAML for Non-programmers".
You might also use this YAML parser I found online to make sure something works before you put it in.
To update your subreddit's config, you will PM the bot a message with any subject and a body in the format UPDATE <subreddit name>.
Config Fields
| Name | Description | Valid Values | Required? |
|---|---|---|---|
| timeframe | The timeframe in which the rule will be applied. Due to my laziness, minutes are not a valid time unit. Just do seconds and multiply by 60 or some shit. | A number followed by a time unit. E.g., "4h", "1 week", etc. | Yes |
| max_allowed | The maximum number of posts that users can make within the timeframe. If 0, no posts will be removed. | Any integer | Yes |
| self | Allows the rule to only be applied to selfposts or linkposts. If a true value is given, only selfposts will be checked and vice versa. If no value is given, both types of post will be checked. | Boolean | No |
| exempt_authors | Users to whom the rule will not be applied. For if you have a post bot or just want someone to be able to post a lot for some reason. | A list of strings | No |
| exempt_flairs | Flair template ids to ignore. | A list of strings | No |
| exempt_titles | Title formats to ignore. Similar to automod regex. | A list of strings or regexes | No |
| exempt_titles_mode | Compilation mode for exempt_titles. Format like "includes regex" to be a pure regex applied to the title, "includes" to apply as text instead of regex, etc. Defaults to "includes-word". | String | No |
| ban | How long to ban users for when violations occur. Enter a value of true to ban permanently. If not provided, no ban will be issued. | Integer or boolean | No |
| ban_note | The internal note to be provided with the ban. Will take the form Floodgates: note on your /about/banned page. | Any string under 300 characters | No |
| ban_message | The message to be sent to users who are banned. Supports placeholders. | Any string | No |
| modmail | A message to be sent to subreddit modmail whenever a violation is found. Supports placeholders. | Any string | No |
| modmail_subject | Subject for modmail. Supports placeholders except {{results}}. If modmail is set but not modmail_subject, the subject will be "Floodgates Violation - {{author}}". | Any string under 300 characters | No |
| report_reason | A string to report the post with. If not given, the post will not be reported. If remove is true, this will be ignored. Supports placeholders except {{results}}. | Any string under 100 characters | No |
| remove | Whether to remove posts on violation. Defaults to true. | Boolean | No |
| lock | Whether to lock posts on violation. Defaults to false. | Boolean | No |
| message | A message to be sent to the OP of a removed submission. Supports placeholders. | Any string | No |
| message_subject | Subject for PM. Supports placeholders except {{results}}. If message is set but not message_subject, the subject will be "Your post to /r/{{subreddit}} has been removed". | Any string under 300 characters | No |
| send_from_subreddit | Whether the message to the OP should be sent from the subreddit. Requires mail permissions. Defaults to false. | Boolean | No |
| comment | A comment to be posted on removed submissions. Supports placeholders. | Any string | No |
| comment_stickied | Whether the removal comment is to be stickied. Defaults to true. | Boolean | No |
| ignore_deleted | Whether to ignore posts that have been deleted by the OP when checking previous posts. | Boolean | No |
| ignore_removed | Whether to ignore posts that have been removed by a moderator when checking previous posts. | Boolean | No |
| grace_period | How long, in minutes, to wait before checking a post. If the post is deleted at the end of this period, the post will be skipped. By default, there is no grace period. | Integer | No |
Placeholders
Several placeholders are supported by Floodgates in several of its possible messages. Unless otherwise specified, assume that all placeholders are available for the fields that support placeholders.
| Name | Description |
|---|---|
| author | Username of the post's author |
| subreddit | Display name of the post's subreddit |
| title | The post's title |
| id | The post's id36 |
| permalink | A permalink to the post |
| results | A newline-separated list of up to 10 previous posts by the user within the timeframe |
| count | The number of posts the user has made within the timeframe |
Example
The following is an example config which will remove posts and post a removal comment if the author has made more than 2 submissions in the last 24 hours, unless the post is deleted or removed:
max_allowed: 2
timeframe: 1 day
ignore_removed: yes
ignore_deleted: yes
modmail: |-
/u/{{author}}, thank you for posting to /r/{{subreddit}}. Unfortunately your post has been removed because you have made more than 2 submissions in the last 24 hours.
Your previous posts:
{{results}}