Skip to content

the-gdmo/AGPRB

Repository files navigation

AGPRB is a general purpose app that can do various different jobs depending on what is needed by the subreddit.

Most functions will be things that only moderators can use.

General Limitations

  • All menu options will appear even if some of the bot's features are disabled. This means that you may see a feature in the burger menu that won't actually do anything when you click on it.

Point System Limitations

  • The optional leaderboard will not pull in points for users until this app awards one. If you have previously used /u/Clippy_Office_Asst or a similar bot to award reputation points in the past, this will make the leaderboard misleading.
  • For flair setting options, if you specify both a CSS class and a flair template, the flair template will be used.

Suggestions

You may wish to create an automod rule that detects phrases like "thank you" and similar in comments that do not have the trigger command, and reply suggesting that they use the command.

I strongly recommend using a command that is not going to be used in "normal" comments, to avoid awarding points accidentally. If you use a prefix e.g. !award or /award, you will reduce the risk of accidental points awarding.

I recommend testing settings out on a test subreddit before deploying to a real subreddit for the first time.

Supported Placeholders

  • {{author}}: The username of the poster. Will not contain 'u/'.
  • {{requirement}}: The amount of points required before a posting restriction is lifted.
  • {{name}}: The name of points. Specified in 'Point Name'.
  • {{permalink}}: Link to the most recent valid post by the poster.
  • {{symbol}}: The symbol associated with your subreddit installation. Specified in 'Point Symbol'.
  • {{awardee}}: The user being awarded. Will not contain 'u/'.
  • {{total}}: The total amount of points a user has.
  • {{helpPage}}: Link to a page explaining how to use the bot. Uses the Old Reddit version of this page.
  • {{leaderboard}}: Link to a page of the subreddit's leaderboard. Uses the Old Reddit version of this page.
  • {{awarder}}: The user giving the award. Will not contain 'u/'.
  • {{threshold}}: Threshold to become a superuser. Specified in 'Auto Superuser Threshold'.
  • {{command}}: Notifies the user who has reached the threshold of a special command they can use. Specified in 'Superuser/Mod award command'.
  • {{commands}}: Lists all valid non-superuser/non-mod command(s) (comma-separated list (if more than 1)). Specified in 'Trigger Words'.
  • {{markdown_guide}}: Link to Reddit's Markdown Guide.
  • {{user}}: The username of the person being awarded. Used in 'Alternate Award Command'.
  • {{altCommand}}: Alternate command to directly award users. Used in 'Alternate Command Success/Fail Message'.
  • {{subreddit}}: Get the name of the subreddit. Will not contain 'r/'.
  • {{awardeePage}}: Link to a user's individual page. Logs all points received and given that are not alternate commands.
  • {{awarderPage}}: Link to a user's individual page. Logs all points received and given that are not alternate commands.
  • {{title}}: The title of the most recent valid post by the poster.

Data Stored

This application stores the reputation score awarded by the app for each user in a Redis data store and (if configured) as the user's flair. It also stores a record that a comment has had a point awarded on it for a period of a week after that point is awarded.

If the application is removed from a subreddit, all data is deleted although the flairs will remain. If the application is subsequently re-installed, the existing flairs will be used as a basis for new point awarding.

Acknowledgements

Code edited from u/fsv's reputatorbot. Part of code imported from u/ryry50583583's therepbot.

About

This app is open source and licensed under the BSD 3-Clause License. You can find the source code on GitHub here.

NOTE: If you remove the app from your subreddit, it will delete all data and you will have to manually restore it to users.

Version History

0.0.2

  • Get point system code out (copied from RepBot)

About

A General Purpose Reddit Bot

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors