A powerful, modular, and anime-themed Telegram bot based on the Pyrogram framework. Ruka is designed to manage your groups efficiently while keeping the Rent-a-Girlfriend aesthetic alive.
Ruka Sarashina is an open-source Telegram management bot built with performance and ease of use in mind. It utilizes a powerful mix of the Pyrogram framework and a Kurigram fork to deliver fast, asynchronous group management tools.
Whether you need anti-spam protection, welcome messages, or administration tools, Ruka is here to serve your group with the dedication of a provisional girlfriend! 💙
- Group Management: Ban, Mute, Kick, and Warn users with precision.
- Anti-Spam: Automated filters to keep your chat clean.
- Welcome & Goodbye: Customizable messages with media support.
- Filters & Notes: Save automatic replies and important notes.
- Federation Support: Ban users across multiple groups.
- Anime Themed: Interactive responses based on Ruka Sarashina.
🛠 Tech Stack
This project stands on the shoulders of giants:
⚡ Deployment
You can deploy this bot easily on your own VPS.
-
Update and Upgrade:
sudo apt-get update && sudo apt-get upgrade -y -
Clone the Repository:
git clone https://github.com/ishikki-akabane/Ruka-bot cd Ruka-bot -
Install Requirements:
pip3 install -U -r requirements.txt
-
Configure Environment: Create a
.envfile or renamesample.envto.envand fill in your values. -
Run the Bot:
python3 -m RUKA
📝 Configuration (Vars)
To run the bot, you need to set up the following environment variables:
| Variable | Description |
|---|---|
API_ID |
Your Telegram API ID (get from my.telegram.org) |
API_HASH |
Your Telegram API Hash |
BOT_TOKEN |
Your Bot Token (get from @BotFather) |
DB_URL |
Your MongoDB Connection String |
🤝 Contributing
Ruka Sarashina is an open-contribution project! We welcome code, documentation, and bug fixes from the community.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/NewFeature) - Commit your Changes (
git commit -m 'Add some NewFeature') - Push to the Branch (
git push origin feature/NewFeature) - Open a Pull Request
- Contribution Guidelines
- Code Quality: Write clean, readable, and well-documented code
- Testing: Test your changes before submitting
- Commit Messages: Use clear, descriptive commit messages
- Respect: Be respectful and constructive in discussions
📜 License
This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE file for details.
Key Points:
| Status | Requirement | Explanation |
|---|---|---|
| ✅ | Use, Modify, and Distribute | You are free to use, run, modify, and share this software. |
| ✅ | Full Attribution Required | You must retain the original copyright notices and credit the author, Ishikki Akabane. |
| ✅ | Share Alike (Copyleft) | Any work derived from or linked to this software must also be licensed under the AGPLv3. |
| ✅ | Source Availability | If you modify and run the bot on a network (like Telegram), you must make your modified source code publicly available to users. |
| ✅ | Transparency | You must document and state all significant changes you have made to the code. |
| ❌ | No Closed-Source | You cannot take the code, close the source, and distribute or sell it as a private, proprietary product. |
| ❌ | No Warranty | This software is provided "AS IS" without any warranty or guarantee of fitness for a specific purpose. |
💬 Support
Need help? Have questions? Found a bug?
- Issues: GitHub Issues
- Template: Please use our issue templates for consistency
- Support Group: Join Support Group
- Developer Chat: DevsLab Community
Contributors
- GitHub: @ishikki-akabane
- Role: Founder & Lead Developer
DevsLab Community
- A thriving community of developers on Telegram
- Join us: t.me/devslab
- Building tools and fostering collaboration
Special Thanks
- Pyrogram and Kurigram for the amazing library.
- Open Source Community for the continuous support.