2022-08-07 04:43:50 -04:00
|
|
|
## About
|
|
|
|
|
This bot is designed to simplify the moderation and management of Telegram groups.
|
|
|
|
|
|
|
|
|
|
## Features
|
2022-11-28 04:40:52 -05:00
|
|
|
|
2023-05-21 14:53:37 -04:00
|
|
|
* User roles
|
|
|
|
|
* User complains system
|
|
|
|
|
* Admin activity log
|
2022-08-07 04:43:50 -04:00
|
|
|
|
2023-05-21 14:53:37 -04:00
|
|
|
## Up
|
2022-11-28 04:40:52 -05:00
|
|
|
|
2023-05-21 14:53:37 -04:00
|
|
|
- Required: python3.11
|
|
|
|
|
- Up Telegram Bot API server on port 5326
|
|
|
|
|
- Use the .env.dist template example for creating .env
|
|
|
|
|
- After first start use `!reload` for parsing members list and permissions
|
2023-01-04 15:10:35 -05:00
|
|
|
|
2022-08-07 04:43:50 -04:00
|
|
|
## Configuration .env
|
|
|
|
|
|
2023-01-04 15:32:37 -05:00
|
|
|
| environment variables | description |
|
|
|
|
|
|-------------------------------|----------------------------------|
|
|
|
|
|
| `bot_token` | telegram bot token |
|
|
|
|
|
| `api_id` and `api_hash` | telegram application data |
|
|
|
|
|
| `group_id` | group id |
|
|
|
|
|
| `second_group_id` | seconds group for admins |
|
|
|
|
|
| `telegram_bot_api_server` | telegram bot api server |
|
2023-07-22 07:07:43 -04:00
|
|
|
| `db_uri` | connection info to database |
|
2023-01-04 15:32:37 -05:00
|
|
|
| `limit_of_warns` | limit user warnings |
|
|
|
|
|
| `update_interval` | interval for update of user data |
|
2022-08-07 04:43:50 -04:00
|
|
|
|
|
|
|
|
## TODO
|
2022-11-28 04:37:31 -05:00
|
|
|
|
2023-05-21 14:53:37 -04:00
|
|
|
- [ ] Multigroup support
|
|
|
|
|
- [ ] Integrate project with docker
|
|
|
|
|
- [ ] Flood detection
|
|
|
|
|
- [ ] Web(in development)
|
2022-08-07 04:43:50 -04:00
|
|
|
|
|
|
|
|
## Support
|
2022-12-11 09:18:11 -05:00
|
|
|
|
2022-08-07 04:43:50 -04:00
|
|
|
Every investition helps in maintaining this project and making it better.
|
|
|
|
|
|
|
|
|
|
<img src="https://img.shields.io/badge/btc-bc1qzp7q3rghzcx70534e7xf6tj0ns3dqvvnex80kf-green?logo=bitcoin">
|
2023-01-04 15:23:49 -05:00
|
|
|
|
|
|
|
|
Don't donate to this wallet yet, I've lost access to it. Wait until I restore the wallet or create a new one.
|
