https://github.com/nacbots/group-guardian
Group Guardian is a Telegram bot for admins to maintain a safe community.
https://github.com/nacbots/group-guardian
bot nacbots nsfw nsfw-classifier nsfw-recognition slag spam-classification spam-detection telegram telegram-bot
Last synced: about 1 year ago
JSON representation
Group Guardian is a Telegram bot for admins to maintain a safe community.
- Host: GitHub
- URL: https://github.com/nacbots/group-guardian
- Owner: NACBots
- License: apache-2.0
- Created: 2023-03-06T03:22:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-15T04:48:46.000Z (over 1 year ago)
- Last Synced: 2025-03-23T23:26:51.273Z (about 1 year ago)
- Topics: bot, nacbots, nsfw, nsfw-classifier, nsfw-recognition, slag, spam-classification, spam-detection, telegram, telegram-bot
- Language: Python
- Homepage: https://nacbots.in
- Size: 8.79 KB
- Stars: 17
- Watchers: 3
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Group Guardian
Group Guardian is an open source Telegram bot designed to help group administrators maintain a clean and safe environment for their communities. The bot offers two main functionalities:
- **Word Slagging:** With the word slagging feature, the bot can detect and remove inappropriate language or spam messages in a group.You can define a list of banned words or phrases in [slang words file](slang_words.txt), and the bot will automatically delete any message containing them.
- **Image Filtering:** The bot also includes an image filtering feature that can automatically detect and remove pornographic or NSFW images in a group and sent a censored version of the image.
## Getting Started
To use Group Guardianship, simply add the bot to your Telegram group and promote to admin.If anyone sends a message containing offensive language or an NSFW image, the bot will automatically delete the message and send a censored version of it instead.
## Required Configs
- `BOT_TOKEN` - Get from [@BotFather](https://t.me/BotFather)
- `API_ID` - Get it from [telegram.org](https://my.telegram.org/auth)
- `API_HASH` - Get it from [telegram.org](https://my.telegram.org/auth)
## Deploy 🚀
### Easiest Heroku Deploy ðŸ¤
### Host Locally 🤕
1. Clone this repository to your local machine using:
```
git clone https://github.com/nacbots/group-guardian
```
2. Install the required dependencies using pip:
```
cd group-guardian
pip install -r requirements.txt
```
3. Create a new bot in Telegram and get your API token (you can follow the instructions [here](https://core.telegram.org/bots#creating-a-new-bot)).
4. Configure the bot's settings by editing the `config.py` file.
5. Start the bot by running:
```
python3 main.py
```
6. Add the bot to your Telegram group and enjoy a clean and safe environment!
## Support Group:
## Contributors
- [@NikhilEashy](https://github.com/nikhileashy)
- [@Muhsina-km](https://github.com/muhsina-km)
## Contributing
If you find a bug or have a suggestion for a new feature, please open an issue on this repository or submit a pull request. We welcome contributions from the community!