Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/disasterpiece9000/InstaMod-2.0

Customizable user flair system for Reddit
https://github.com/disasterpiece9000/InstaMod-2.0

Last synced: 4 days ago
JSON representation

Customizable user flair system for Reddit

Awesome Lists containing this project

README 

        
# InstaMod v2.0 - Customizable user flair system



InstaMod is a toolbox of features that moderators can implement and tailor fit to their needs. With a robust feature set and unlimited combinations of settings, InstaMod gives moderators the ability to customize and moderate their community in ways that AutoModerator can't. 



To get a better idea of the customization options available, please check out the [settings documentation](https://github.com/disasterpiece9000/InstaMod-2.0/blob/master/Documentation/SettingsDocumentation.md) or one of the subreddits currently using InstaMod

* [/r/CryptoCurrency](https://www.reddit.com/r/CryptoCurrency)

* [/r/CryptoTechnology](https://www.reddit.com/r/CryptoTechnology)

* [/r/CryptoMarkets](https://www.reddit.com/r/CryptoMarkets)



## Features - Flair Management



### User Tiers



As a user participates more and more in the community, their flair can change to represent their involvement. Certain tiers, or levels of user participation, can grant the user access to special privileges. This includes the ability to assign themself custom flair and the ability to add CSS to their automatic flair. This system rewards frequent contributors and encourages new users to stop lurking and start participating!



### Activity Tags



Moderators can configure InstaMod to include information about user' account history in their flair . It could display a user's top 3 most used related communities, or it could be setup to display the subreddits where the user has been consistently downvoted. These are just a few examples of the endless combinations of settings at your disposal.



### PM Commands



PM commands allow users and moderators to quickly and easily interact with InstaMod.



| Command | Description | Permitted Users |

| ----------- | ----------- | ----------- |

| !noautoflair | Prevents InstaMod from assigning automatic flair to the specified user. This allows moderators to assign a user flair without InstaMod overwriting it and without that user getting full custom flair permissions. | Moderators |

| !giveflairperm | Gives the specified user custom flair permissions. The user will be automatically notified after the command is processed. | Moderators |

| !updatesettings | Re-read the wiki settings page so that settings changes can take place instantly. InstaMod automatically re-checks settings each hour | Moderators |

| !updatethem| Update the specified user's account data and flair, regardless of if their information is out of date | Moderators |

| !updateme | Update the senders account data and flair, regardless of if their information is out of date | All users |

| !flair | Change the user's flair text and CSS to whatever they specify | Users with custom flair permissions |

| !css | Change the user's CSS to whatever they specify | Users with custom CSS permissions |



_____



## How to run



Unlike most bots, InstaMod is designed to simultaneously support multiple subreddits. This means that adding it to your subreddit doesn't require any technical knowledge or hosting capability! If you are interested in incorporating it into your subreddit all you need to do is create a wiki page called "InstaModSettings", fill it with the information specified in the [settings documentation](https://github.com/disasterpiece9000/InstaMod-2.0/blob/master/Documentation/SettingsDocumentation.md), and [contact me](https://www.reddit.com/message/compose?to=shimmyjimmy97&subject=InstaMod&message=) so that I can import your subreddit.



If you would like to run your own version of InstaMod, here are the required components:

* Python 3.7.4 or higher

* SQLite 3.25.0 or higher

* PRAW

* PSAW

* Fill in your Reddit account credentials in the praw.ini file

* Fill in all the subreddits the bot will run on (delimited by new lines) in the subreddit_master_list.txt file



Once the above steps have been completed, run this command to start the bot:

> python3 Main.py



**Note:** This bot requires you run it with Python 3.7.4 or higher so make sure that the version of Python you run the script with is correct or the bot will not function properly.