Posts
Wiki
Basic Configuration
QualityVote 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.
Config Fields
| Name | Description | Valid Values | Default |
|---|---|---|---|
| vote_comment | The text of the vote comment - supports placeholders - bot will do nothing if this isn't set | Any string | None |
| report_threshold | The minimum score of the vote comment to report | Any integer | None |
| remove_threshold | The minimum score of the vote comment to remove the post | Any integer | None |
| check_after | Number of time units before checking the vote comment - if set, the vote comment will only be checked once | Any integer | None |
| check_after_mode | Time unit to use for check_after | Hour, minute, second, etc | Minute |
| delete_after_check | Whether to delete the vote comment after the check - this will be ignored if check_after is not set | True or false | False |
| removal_comment | Comment to leave after removing posts - supports placeholders | Any string | None |
| modmail_body | Message to send to modmail after removing posts - supports placeholders - if not set, no modmail will be sent | Any string | None |
| modmail_subject | The subject of the modmail sent after removals (if one is set) - supports placeholders - this will be ignored if modmail_body is not set | Any string | "Removal threshold reached" |
| report_reason | Reason to report with - supports placeholders | Any string | None |
| report_comment | Whether to report the vote comment instead of the original submission | True or false | False |
| skip_approved | Whether to skip removal for posts that have been previously approved by a moderator | True or false | True |
| approval_bots | Usernames that will not count for the feature implemented by skip_approved - should be a list of bots on your subreddit that perform unprompted approvals - e.g. MAGIC_EYE_BOT | A list of usernames | None |
| ignore_flairs | Flair template IDs whose posts will not receive vote comments - note that the flair will need to be set as the post is made | A list of flair template IDs | None |
| is_self | If present, whether to check only self posts (true) or only link posts (false) - if not present, post type will be disregarded | True or false | N/A |
Placeholders
Several placeholders are supported by QualityVote in several of its possible messages.
| Name | Description |
|---|---|
| {{author}} | The username of the author of the post |
| {{subreddit}} | The display name of the subreddit in which the comment is being left |
| {{body}} | The body of the post (NOT RECOMMENDED) |
| {{title}} | The title of the post |
| {{id}} | The base36 ID of the post (if you don't know what that means, you don't need to use it) |
| {{permalink}} | A URL linking to the post |
| {{domain}} | The domain of the post |
| {{link}} | The URL the post links to (the same as {{permalink}} for self posts) |
| {{author_flair_text}} | The flair text of the post's author, or blank if they have none |
| {{author_flair_css_class}} | The flair CSS class of the post's author, or blank if they have none |
| {{author_flair_template_id}} | The flair template ID of the post's author, or blank if they have none |
| {{link_flair_text}} | The flair text of the post, or blank if it has none |
| {{link_flair_css_class}} | The flair CSS class of the post, or blank if it has none |
| {{link_flair_template_id}} | The flair template ID of the post |
| {{author_id}} | The base36 ID of the post's author (if you don't know what that means, you don't need to use it) |
| {{subreddit_id}} | The base36 ID of the subreddit in which the comment is being left (if you don't know what that means, you don't need to use it) |
Example
The following is an example config which will post a comment on every new thread, report the post when the comment reaches -2, and remove the post when the comment reaches -5 (with a removal comment):
vote_comment: |-
Hi! This is our community moderation bot.
---
If this post fits the purpose of /r/{{subreddit}}, **UPVOTE** this comment!!
If this post does not fit the subreddit, **DOWNVOTE** This comment!
If this post breaks the rules, **DOWNVOTE** this comment and **REPORT** the post!
report_threshold: -2
remove_threshold: -5
removal_comment: /u/{{author}}, thank you for your submission. Unfortunately, your post has been removed because it has been voted unsuitable for /r/{{subreddit}}.