Skip to content
This repository has been archived by the owner on Jul 19, 2023. It is now read-only.
/ lemmod Public archive

Very experimental prototype of an AutoModerator like tool for Lemmy

License

Notifications You must be signed in to change notification settings

ShittyKopper/lemmod

Repository files navigation

lemmod

Extremely messy prototype of a moderation bot for Lemmy communities.

How it works

  1. You invite an instance of this bot to one or more communities as a moderator.
  2. You use it's DMs as a command like interface to give it scripts to run.
  3. It will chug along in the background doing it's thing.

Read the documentation for more info.

Scripts

lemmod uses YAML with (some) templating for it's scripts, which exchanges flexibility with security (i.e. you should be able to safely host a public lemmod without worrying about getting pwned) and explicitly limited functionality (so mods can't easily instruct the bot to spam random communities or whatnot)

YAML isn't REALLY the best tool for this job, but it's widely used and is easy to grasp (hi Nix)

Setup

Building

$ git clone https://github.com/ShittyKopper/lemmod
$ npm install --dev
$ npm run build

Configuration

Rename .env.template as .env and edit as needed. Alternatively, any other way of providing environment variables will work.

Startup

You can run the bot with npm run start

About

Very experimental prototype of an AutoModerator like tool for Lemmy

Topics

Resources

License

Stars

Watchers

Forks