Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dessalines/reddit-banbot
Reddit-Banbot is a reddit bot that can ban users from your community based on karma gained in unwanted communities.
https://github.com/dessalines/reddit-banbot
reddit reddit-api reddit-bot
Last synced: about 1 month ago
JSON representation
Reddit-Banbot is a reddit bot that can ban users from your community based on karma gained in unwanted communities.
- Host: GitHub
- URL: https://github.com/dessalines/reddit-banbot
- Owner: dessalines
- License: gpl-3.0
- Created: 2018-07-24T18:32:01.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T15:04:54.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T07:41:47.516Z (7 months ago)
- Topics: reddit, reddit-api, reddit-bot
- Language: TypeScript
- Homepage:
- Size: 52.7 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Reddit-Banbot
Reddit-Banbot is a reddit bot that can ban users from your community based on karma gained in unwanted communities.
You provide it with:
- A list of the communities you dislike.
- A bad karma threshold gained in those communities.
- A subreddit you moderate.
- A sort order for threads to scan from that subreddit.
- A sort order for users comments (it only fetches 100, so either new or top comments)
## Running
`./run.sh` , or run the following command:
```sh
yarn && tsc -p . && node dist/out-tsc/banbot.js \
--clientId X \
--clientSecret X \
--username X \
--password X \
--badSubs={X1,X2} \ # {cringeanarchy, milliondollarextreme}
--subreddit X \ # the subreddit this user is a moderator of
--threadSort X \ # hour, day, week, month, year, all
--userCommentSort X \ # new, top
--badKarma X \ # A minimum accumulated bad karma threshold
--banDuration X \ # Number of days
--removeComments \ # optional, Removes their comments from the subreddit too
--save \ # Saves users, submissions, and ban report out to the saved folder
--dryRun # optional, doesnt ban
```
## Requirements
- node, typescript, yarn
### Setup a reddit script client
*This is required to make API calls to reddit at the rate of at least 1 per second.*
- Go [here](https://www.reddit.com/prefs/apps)
- Click create another app
- Click personal use script
- Copy down the `client_id`, and `client_secret` for later use.
## Bugs and feature requests
Have a bug or a feature request? If your issue isn't [already listed](https://github.com/tchoulihan/reddit-banbot/issues/), then open a [new issue here](https://github.com/tchoulihan/reddit-banbot/issues/new).