Elara6331
/
lemmy-reply-bot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add features section to README

This commit is contained in:
Elara 2022-12-13 10:27:28 -08:00
parent 58c86d9070
commit 059571e2ec
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -2,6 +2,14 @@
This project is a simple bot that replies to comments on Lemmy. It uses Lemmy's WebSocket to get notified of any new comments, and sees if they match any regex configured in the config file. If it finds one that does, it replies with the message corresponding to that regex.
### Features
- Multiple replies in a single bot instance
- Powerful PCRE2 regular expressions for detecting triggers
- Ability to use regex capture groups in replies
- Persistent duplicate reply prevention via a filesystem store
- Uses event-based WebSocket API, which means near-instant replies and no rate limiting
### Configuration
This repo contains a file called `lemmy-reply-bot.example.toml`. This is an example config file. Copy it to `lemmy-reply-bot.toml` and edit it to fit your needs. The config contains your password, so its permissions must be set to 600 or the bot will refuse to start.