Skip to content

Latest commit

 

History

History
194 lines (143 loc) · 7 KB

README.md

File metadata and controls

194 lines (143 loc) · 7 KB
Raw

Contributors Forks Stargazers Issues GNUv3 License


Logo

Gort

A modular typescript reddit moderation tool with a rule-action paradigm as a supplement to automod
Explore the docs »
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Acknowledgments

About The Project

An iterative improvement upon its predecessor, Gort is a typescript reddit moderation bot which can act as a supplement (or upgrade) to reddit's automoderator, born out of a need for more complicated rulesets and context-sensitive actions. Rules can be created simply using in-built helper classes, allowing non-programmers to make additions.

My aim for the future of the project is to create an easy-to-use web-interface that will allow moderators to configure the bot at runtime. Another posibility includes configuring the bot through reddit wiki pages.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm 
    npm install npm@latest -g

Installation

  1. Clone the repo 
    git clone https://github.com/jamesxx/gort.git
  2. Install NPM packages 
    npm install
  3. Configure the bot in .env 
     DISCORD_TOKEN=
 REDDIT_USERAGENT=
 REDDIT_CLIENTID=
 REDDIT_CLIENTSECRET=
 REDDIT_USERNAME=
 REDDIT_PASSWORD=
 REDDIT_SUBREDDIT=
 DATABASE_URI=

(back to top)

Usage

Once configured, Gort can be used to perform automated actions on new comments and submissions in your subreddit based on logic defined in its ruleset. This includes banning users, locking or removing comments, replying to a new comment or submission automatically (which itself can be locked and/or distinguished), adding a usernote on a user, or making a notification to a chosen Discord channel.

More niche uses include getting notified about new comments or submission made by selected users, and detecting comments made by traffic originating from other subreddits from which yours has been linked, as a means of detecting and thwarting brigading.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Detect repeat posts automatically
  • Detect whether a user is making a comment in your subreddit for the first time
  • Catch editted and modqueued items aswell, not only new comments/submissions
  • Modmail notifications
  • Call commands as a comment, to make mobile moderation easier
  • Web interface
    • Persistent variables and customisation from web for rules
    • Stats interface to monitor subreddit health

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GPL-3.0-only License. See LICENSE.md for more information.

(back to top)

Acknowledgments

(back to top)