Giter Site home page Giter Site logo

soapdev2018 / blissroms_bot Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 1.0 72 KB

This bot is designed to provide the BlissRoms community with easy access to information about officially supported devices and download links from SourceForge for both vanilla and gapps versions of BlissRoms.

Home Page: https://telegram.dog/blissrom_bot

License: MIT License

Python 100.00%
apscheduler httpx pipenv pyrogram pyrogram-bot python3 python311 telegram-bot yaml

blissroms_bot's Introduction

BlissRoms Logo

BlissRoms Telegram Bot

Welcome to the BlissRoms Telegram Bot project! This bot is designed to provide the BlissRoms community with easy access to information about officially supported devices and download links from SourceForge for both vanilla and gapps versions of BlissRoms.

Features

  • List officially supported devices for BlissRoms.
  • Provide download links for vanilla and gapps versions of BlissRoms from SourceForge.
  • User-friendly interface for quick access to information.
  • Auto-deletes long messages in private chats and groups (with permission) to avoid cluttering the chat.

Getting Started

To use the BlissRoms Telegram Bot, follow these steps:

  1. Invite the Bot: Add the bot to your Telegram group or send it a direct message. You can find the bot by searching for its username in Telegram: @blissrom_bot.

  2. Commands: Use the following commands to interact with the bot:

    • /start: Get a welcome message and an overview of available commands.
    • /help: Get a help message about the available commands.
    • /list: View the list of officially supported devices for BlissRoms.
    • /bliss [device]: Get the download links for the specified device.
    • /refresh: Authorized users' only command. Refreshes the locally cached devices.json file.

Examples

  • To view the list of supported devices: /list
  • To get download links for a specific device: /bliss obiwan

Dependencies

Bot Deployment

  1. Install Python for your distribution
  2. Run the following command to install pipenv: pip/pip3 install pipenv
  3. Clone this repository: git clone https://github.com/SoapDev2018/BlissRoms_Bot BlissRoms_Bot
  4. Go into the directory: cd BlissRoms_Bot/
  5. Let pipenv install the dependencies (in a virtual environment): pipenv install
  6. Rename sample_config.yml to config.yml and fill in the values (described below)
  7. Run a pipenv shell: pipenv shell and then: python bliss.py. Alternatively: pipenv run python bliss.py

YAML Values

  • api_id: Your Telegram API_ID (from https://my.telegram.org)
  • api_hash: Your Telegram API_HASH (from https://my.telegram.org)
  • bot_token: Your bot's token (from https://telegram.dog/BotFather)
  • authorized_ids: Authorized users, who can use the /refresh command
  • download_url: BlissRoms' download URL; do not modify unless you know what you're doing!
  • user_agent: Custom User-Agent to send to the download server
  • default_user_agent: The default UA passed, if user_agent is not defined
  • group_ids: Authorized Telegram chats, leave blank to allow all chats

Contributing

Contributions to this project are welcome! If you'd like to contribute, follow these steps:

  1. Fork the repository.
  2. Create a new branch for your changes: git checkout -b feature/new-feature
  3. Make your changes and commit them: git commit -m "Add new feature"
  4. Push it back up to GitHub: git push origin feature/new-feature
  5. Create a pull request from your branch to the main repository.

License

This project is licensed under the MIT License.

Contact

If you have any questions or feedback about the BlissRoms Telegram Bot, you can reach out to the team on Telegram or create an issue in this repository.

Happy chatting and downloading BlissRoms!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.