Here I will describe each element of the provided config file, list the possible options for each setting, and provide some example cases. If you want to jump to the interesting bits, please see the "Defining a rule" section. But it mighttttt not make a ton of sense
- Indentation matters - The bot runs on Python so indentation is considered syntax
- Quotation marks are key - Everything except numbers, True/False, and None should be encased in either ' or ". It doesn't matter what you choose, as long as the opening quotation mark matches the closing one.\
- Case sensitive - Be sure what you add for certain sections, such as permissions, matches the correct case. Some things use all upper case, other use all lower case. Some contain spaces, and other use underscores instead. I will work on making this more consistent in future updates.
- Commas - The end of each line in a section or subsection should contain a comma. The exception to this rule is the last line of each section or subsection. So if you add a new line, and it's not the last line, throw a comma in there at the end. This one is tricky if you aren't familiar with coding syntax, but in general, just follow the pattern of the existing settings and you should be fine.
- name - Name of the subreddit InstaMod is running on
- abbrev - Abbreviation of the subreddit
- mods - Comma seperated list () of usernames. Each username shold be encased in ''
- thread_lock to sub_tags - Accepts True/False values to turn on/off the feature
- tag_expiration - Number of days until a user's flair is reassessed
- accnt_age - Represents number of months. If an account is younger than this, then they will get a tag for it. Change it to None to disable
- update_interval - set to 'INSTANT' for users to be analyzed as they are seen, or set it to any number <= 500 to flair users in batches. Once the stored lis of users is >= this number, they will be flaired
- approved_icons - a comma seperated list () of flair :images: that users with 'FLAIR_ICONS' permission will be able to use.
Comments with values >= both of these numbers count as 1 positive QC
- positive karma - comments must have a score thats >= this number
- positive words - comments must contain an amount of words >= this number
Comments with values <= both of these numbers count as 1 negative QC
- negative karma - comments must have a score thats <= this number
- negative words - comments must contain an amount of words <= this number
Each term must be used inbetween '' and typed the same way
- total comment karma, total post karma, total karma - Self explanatory. These values are for across all subreddits and will ignore the 'target_sub' rule setting. They will not be totaled like other data points.
- comment karma and post karma - Total comment/post karma by subreddit
- positive comment and negative comment - Count of comments with a score < 0 or > 0 by subreddit
- positive post and negative post - Count of posts with a score < 0 or > 0 by subreddit
- positive QC, negative QC, net QC - The number of QC by subreddit. net_QC_counter consists of the negative QC subtracted from the positive QC by subreddit
- A_SUBS/B_SUBS - Moderators can define 2 lists of subreddits. Each subreddit in a list must be accompanied by an abbreviation/nickname. Subreddits with identical abbreviations will be grouped together and have their data combined.
- ALL_SUBS - A combination of A_SUBS and B_SUBS
- ('OneSub', 'AnotherSub', 'AndSomeMore,) - Subreddits can be listed inside the parentheses to create a sub-list. These subreddits must already exist in either A_SUBS or B_SUBS.
- LESS_THAN - <
- GREATER_THAN - >
- EQUAL_TO - =
- NOT_EQUAL_TO - !=
- GREATER_THAN_EQUAL_TO - >=
- LESS_THAN_EQUAL_TO - <=
- this can be any integer value
- this can be any string text
- this must be already defined in the subreddit settings
- FLAIR_IMAGES - The user will be able to append their flair with a selection of :image: flair's that the subreddit has already defined. Available :images: can be set using the approved_icons list in the sub_config option
- CUSTOM_FLAIR - The user can assign themself custom flair and overwrite the automatic flair. User's must have control of their flair revoked for this bot to effectively flair users.
Wow you made it this far. I'm honestly impressed. Lucky for you, this is where it gets juicy. Let's take a look at a sample rule and see if we can make sense of it:
'tier1' : {'metric' : 'positive comments',
'target_subs' : ('A_SUBS'),
'comparison' : 'LESS_THAN_EQUAL_TO',
'value' : 20,
'flair_text' : 'New Arrival',
'flair_css' : None,
'permissions' : None},
I speek nerd so allow me to translate: If a user has 0 - 20 positive comments in subreddits from A_SUBS, then they get the tag "New Arrival" in their flair text. See that wasn't so hard right?! The configuration file comes with a few examples of the different types of rules and their "translations".
Did you catch that? I said "different types of rules"...did you really think I was going to make it THAT easy for you? Each rule type has mostly the same set of options. Below we will go over each rule type, their new settings, and give an example.
This is the same type that was used in the example above. A user can only be assigned 1 of the tags in this set of rules, so that they represent different stages of subreddit progression. This is also the onyl rule set that can grant users permissions. For instance, here is the next example in the set of example progression tags:
'tier2' : {'metric' : 'positive comments',
'target_subs' : ('A_SUBS'),
'comparison' : 'LESS_THAN_EQUAL_TO',
'value' : 50,
'flair_text' : 'Been Here',
'flair_css' : None,
'permissions' : None},
This one reads almost the same. The only thing that's changed is the value option. Since only one of these tiers can be selected, the rule reads as: If a user has 21 - 50 positive comments in subreddits from A_SUBS, then they get the tag "Been Here" in their flair text
These tags are applied for each subreddit (individually) in the target_subs setting. That means that their metrics are not totaled like in the previous section. Before I show you an example, we've got some more key terms to go over class. Take out your pen, and get something to write on:
- sort - This can be set to MOST_COMMON, LEAST_COMMON, or None. Most common sorts the results from high to low, least common sorts them from low to high, and None just returns them in the order they are listed.
- tag_cap - The maximum number of subs that will be listed as a result of the rule
- show_value - This will append the subreddit abbreviation with ": X" where X is the number corresponding to the user's specified metric
- pre_text and post_text - These strings are concatonated with the subreddit abbreviation
Since you've stuck with me this far, here are 2 examples:
'subtag1' : {'metric' : 'net QC',
'target_subs' : ('A_SUBS'),
'sort' : 'MOST_COMMON',
'tag_cap' : 3,
'comparison' : 'GREATER_THAN_EQUAL_TO',
'value' : 15,
'show_value': True,
'pre_text' : 'r/',
'post_text' : ' QC'},
'subtag2' : {'metric' : 'net QC',
'target_subs' : ('A_SUBS'),
'sort' : 'LEAST_COMMON',
'tag_cap' : 3,
'comparison' : 'LESS_THAN_EQUAL_TO',
'value' : -10,
'show_value': False,
'pre_text' : 'Trolls r/',
'post_text' : ''}
The first rule tags users with 15 or higher net QC with the text "r/SomeSub : X QC", while the second rule tags users with -10 or less net QC with the text "Trolls r/SomeSub". Where "SomeSub" is the given abbreviation for a subreddit.
InstaMod will scan for posts with specific post flair and filter the comments under it. A comment can either be removed or marked as spam. The bot can also notify users of their comment's removal. Same as the last one, we've got some new key terms:
- flair_ID - The post flair text that the bot looks for
- action - This can be set to "REMOVE" to remove the comment, or "SPAM" to mark the comment as spam
- remove_message - Message that will be sent to the user if their comment is removed. Set to None to not reply
Ok now that that's out of the way, more examples! Here is a thread lock that filters out the same users who would have the "New Arrival" tag that we previously defined:
'threadlock1' : {'metric' : 'positive comments',
'target_subs' : ('CM'),
'comparison' : 'LESS_THAN_EQUAL_TO',
'value' : 20,
'flair_ID' : 'lvl 1 Lock',
'action' : 'REMOVE'},