nbuechner/matrix-nsfwbot
nbuechner/matrix-nsfwbot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update README.md

Browse source
This commit is contained in:
Nils Büchner 2024-09-27 08:53:26 +02:00
parent bb8e2411f2
commit 92fc828dfd
1 changed files with 1 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -8,7 +8,6 @@
- **Image Analysis**: Detects and analyzes images posted in Matrix chats using NudeNet. - **Image Analysis**: Detects and analyzes images posted in Matrix chats using NudeNet.
- **Redaction of Spammed Images**: Automatically redacts images when users send more than the allowed number within a short time frame. - **Redaction of Spammed Images**: Automatically redacts images when users send more than the allowed number within a short time frame.
- **Text Message Parsing**: Analyzes images embedded in text messages. - **Text Message Parsing**: Analyzes images embedded in text messages.
- **Configurable Concurrency**: Controls concurrent image processing tasks.
- **Custom Actions**: Configurable actions for detected content, including reporting and redacting messages. - **Custom Actions**: Configurable actions for detected content, including reporting and redacting messages.
## Requirements ## Requirements
@ -16,8 +15,6 @@
- **Maubot**: Runs within the Maubot framework. - **Maubot**: Runs within the Maubot framework.
- **Python Dependencies**: `nudenet`, `beautifulsoup4`, and `maubot`. - **Python Dependencies**: `nudenet`, `beautifulsoup4`, and `maubot`.
> **Note**: The `nudenet` package and other dependencies will not run on Alpine Linux, so use the custom Debian-based Maubot Docker image.
To install the dependencies, you can find them listed in the `requirements.txt`: To install the dependencies, you can find them listed in the `requirements.txt`:
```plaintext ```plaintext
beautifulsoup4 beautifulsoup4
@ -57,7 +54,7 @@
- `max_images`: The maximum number of images a user can send within a certain time window (default: `3`). - `max_images`: The maximum number of images a user can send within a certain time window (default: `3`).
- `time_window`: The time window (in seconds) in which the image count is tracked (default: `60` seconds). - `time_window`: The time window (in seconds) in which the image count is tracked (default: `60` seconds).
> **Note**: `report_to_room` can be a room alias (like `#room:server`), but it is more efficient to use a room ID (`!room:server`). > **Note** `report_to_room` can be a room alias (like `#room:server`), but it is more efficient to use a room ID (`!room:server`).
## Usage ## Usage
@ -86,10 +83,5 @@ If a user sends too many images:
User @example:matrix.org has exceeded the image limit. Previous images redacted. User @example:matrix.org has exceeded the image limit. Previous images redacted.
``` ```
## Contributing
Contributions are welcome! Open an issue or submit a pull request on GitHub.
## License
This project is licensed under the AGPLv3 License. See the [LICENSE](LICENSE) file for details.