Add READM.md & gitignore
This commit is contained in:
commit
2c6a54d435
|
@ -0,0 +1,10 @@
|
||||||
|
__pycache__
|
||||||
|
database/db.db
|
||||||
|
database/__pycache__
|
||||||
|
handlers/__pycache__
|
||||||
|
filters/__pycache__
|
||||||
|
config/__pycache__
|
||||||
|
modules/__pycache__
|
||||||
|
.env
|
||||||
|
pyrightconfig.json
|
||||||
|
session.session
|
|
@ -0,0 +1,47 @@
|
||||||
|
## About
|
||||||
|
This bot is designed to simplify the moderation and management of Telegram groups.
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<img src="https://img.shields.io/badge/license-GPL-blue">
|
||||||
|
</p>
|
||||||
|
|
||||||
|
## Features
|
||||||
|
Ban,mute users(for a specified time).
|
||||||
|
|
||||||
|
Report users.
|
||||||
|
|
||||||
|
User complaints.
|
||||||
|
|
||||||
|
Enable/Disable stickers/images.
|
||||||
|
|
||||||
|
Logging admin command actions in database.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
- Required:Python3 3.x,poetry.
|
||||||
|
- Clone this repo.
|
||||||
|
- Telegram API Service on port 5326.
|
||||||
|
- Move the .env.dist text template to .env and configure him.
|
||||||
|
- First start use `!reload` for parsing members and permissions
|
||||||
|
|
||||||
|
## Configuration .env
|
||||||
|
|
||||||
|
| Name | Description |
|
||||||
|
|-----------------------------------| -------------------------------- |
|
||||||
|
| `bot_token` | Telegram bot token |
|
||||||
|
| `telegram_bot_api_server` | Telegram bot api server |
|
||||||
|
| `db_url` | Connection info to database |
|
||||||
|
| `api_id` and `api_hash` | Telegram application data |
|
||||||
|
| `group_id` | Group id |
|
||||||
|
| `telegram_log_chat` | Seconds group for admins |
|
||||||
|
| `vt_api` | VirusTotalAPI token (optionaly) |
|
||||||
|
|
||||||
|
## TODO
|
||||||
|
- [x] System rules 🔒
|
||||||
|
- [ ] Analys file for malware 🔎
|
||||||
|
- [ ] Paste text to PasteBin or PrivNote 📋
|
||||||
|
- [ ] Site for group moderator 🌍
|
||||||
|
|
||||||
|
## Support
|
||||||
|
Every investition helps in maintaining this project and making it better.
|
||||||
|
|
||||||
|
<img src="https://img.shields.io/badge/btc-bc1qzp7q3rghzcx70534e7xf6tj0ns3dqvvnex80kf-green?logo=bitcoin">
|
Reference in New Issue