Skip to content

READMEen.md

Latest commit

 

History

History
106 lines (76 loc) · 5.53 KB

READMEen.md

File metadata and controls

106 lines (76 loc) · 5.53 KB

🎥 RanchBot 🤖

🎥 Watch the RanczoClips Bot in action: 🎬 Watch the video

RanchBot is a highly customizable Telegram bot designed to manage and process video clips from various TV series. 🎬 The bot allows users to search for specific quotes, manage their own video clips, and perform various administrative tasks related to user management and content moderation. The bot supports multiple series - users can switch between them using the /serial command.

🌟 Features

1. 🎞️ Video Clip Management

  • 🔍 Search for Quotes: Users can search for specific quotes within the series using commands like /clip <quote> and /search <quote>. The bot will return matching video segments.
  • 🎛️ Clip Compilation: Users can compile multiple clips into a single video file with commands like /compile <clip_numbers> or /compile all.
  • ⏱️ Clip Adjustment: The bot allows for fine-tuning of clips by adjusting start and end times using /adjust <clip_number> <adjust_before> <adjust_after>.
  • 💾 Saved Clips Management: Users can save, list, and delete their clips with commands like /save, /myclips, and /deleteclip.

2. 🛠️ User and Role Management

  • 👮‍♂️ Admin and Moderator Roles: Admins and moderators have access to specific functionalities. Commands like /listadmins and /listmoderators help view these roles.
  • 👥 Whitelist Management: Users can be added to or removed from the whitelist, allowing them access to certain features. Use /addwhitelist <user_id> or /removewhitelist <user_id> for this.
  • 📝 Notes on Users: Admins can add notes to user profiles using the /note <user_id> <note> command.

3. 🔒 Content Moderation

  • ⚠️ Report Issues: Users can report issues directly to admins using the /report <issue_description> command.
  • ⏳ Cooldown and Limits: To prevent spamming, cooldown periods and limits are enforced for non-admin users, ensuring a balanced usage experience.

4. 📈 Elasticsearch Integration

  • The bot is integrated with Elasticsearch to efficiently manage and search through transcripts of the series. This integration allows fast and accurate retrieval of video segments based on text queries.

5. 💽 Database Management

  • The bot uses PostgreSQL for storing user data, video clips, search history, and logs. Database operations like initializing the schema and managing user data are handled through a set of robust asynchronous functions.

6. 🐳 Dockerized for Easy Deployment

  • The bot is fully containerized using Docker, making it easy to deploy and run on any system. The Docker setup ensures all dependencies and configurations are handled seamlessly.

🔑 Key Commands

Basic User Commands

  • /start: Displays a welcome message with basic commands.
  • /clip <quote>: Searches for a specific quote and returns the matching video clip.
  • /myclips: Lists all the clips saved by the user.
  • /compile <clip_numbers>: Compiles selected clips into one video.

Administrative Commands

  • /admin: Displays admin commands.
  • /listadmins: Lists all admins.
  • /listmoderators: Lists all moderators.
  • /addwhitelist <user_id>: Adds a user to the whitelist.
  • /removewhitelist <user_id>: Removes a user from the whitelist.
  • /note <user_id> <note>: Adds or updates a note for a user.
  • /report <issue_description>: Reports an issue to the admins.

For a full list of commands, refer to the 📚 Commands Documentation.

📋 Prerequisites

  • Python 3.12
  • PostgreSQL Database
  • Elasticsearch
  • FFmpeg

📦 Required Python Libraries

  • ffmpeg
  • elasticsearch
  • urllib3
  • python-dotenv
  • requests
  • tabulate
  • Retry
  • psycopg2-binary
  • aiogram
  • asyncpg
  • pydantic-settings
  • pydantic

🤝 Contributing

Contributions are always welcome! If you'd like to help improve the project, feel free to collaborate by submitting pull requests or suggesting changes.

📄 License

This project is NOT Open Source. It is Source Available software with All Rights Reserved.

Terms of use:

  • ✅ Personal Use: You may download and run the bot for your own private, personal use.
  • 🤝 Contributing (Pull Requests): Contributions are welcome! You may fork this repository solely for the purpose of submitting a Pull Request back to this main repository.
  • ❌ NO REDISTRIBUTION: You are strictly prohibited from publishing, hosting, or maintaining public forks/mirrors of this project as standalone repositories.
  • ❌ NO COMMERCIAL USE: You are strictly prohibited from using this software for any commercial purpose or profit.

Please submit any changes via Pull Requests to this repository. Let's keep the development centralized!

Full license details are available in the LICENSE file.

🚀 Get Access to the Bot

If you're interested in accessing the RanchBot, please reach out to me on Telegram: @dam2452.

☕ Support the Project

If you like this project and would like to support its development, consider buying me a coffee:

Get me a Mamrot