Skip to content
This repository has been archived by the owner on May 15, 2021. It is now read-only.

Latest commit

 

History

History
173 lines (148 loc) · 7.19 KB

README.md

File metadata and controls

173 lines (148 loc) · 7.19 KB

Userge-x

USERGE-X

Pluggable Telegram UserBot

Open Source Love svg1 GPLv3 license Stars Forks Issues Open Issues Closed PR Open PR Closed Repo Size CodeFactor DeepSource Gitpod ready-to-code Docker Image

USERGE-X is a Powerful , Pluggable Telegram UserBot written in Python using Pyrogram.

Disclaimer

/**
   ⚠️Kang at your own risk⚠️          
   Your Telegram account may get banned.
   I am not responsible for any improper use of this bot
   This bot is intended for the purpose of having fun with memes,
   as well as efficiently managing groups.
   It can help you with managing yourself as well.
   You ended up spamming groups, getting reported left and right,
   and then you ended up in a Final Battle with Telegram
   and at the end the Telegram Team
   deleted your account?
   And after that, you pointed your fingers at us
   for getting your account deleted?
   We will be rolling on the floor laughing at you.
   Yes! you heard it right.
/**

Requirements

How To Deploy

  • With Heroku:

Press to Takeoff


NOTE : your can fill other vars as your need and they are optional. (settings -> reveal config vars)

  • First click The Button Above.
  • Fill API_ID, API_HASH, DATABASE_URL, LOG_CHANNEL_ID, HEROKU_APP_NAME and HEROKU_API_KEY (required)
  • Then fill Dual Mode vars : OWNER_ID, BOT_TOKEN and HU_STRING_SESSION
  • Then fill other non-required vars later
  • Finally hit deploy button

String Session

VAR -> HU_STRING_SESSION

By HEROKU

  • open your app then go to more -> run console and type bash genStr and click run.

On REPL

Read more

Details and Guides

Other Ways

  • With Docker 🐳 See Detailed Guide

  • With Git, Python and pip 🔧

    # clone the repo
    git clone https://github.com/code-rgb/userge-x.git
    cd userge-x
    
    # create virtualenv
    virtualenv -p /usr/bin/python3 venv
    . ./venv/bin/activate
    
    # install requirements
    pip install -r requirements.txt
    
    # Create config.env as given config.env.sample and fill that
    cp config.env.sample config.env
    
    # get string session and add it to config.env
    bash genStr
    
    # finally run the USERGE-X ;)
    bash run

Guide to Upstream Forked Repo

Upstream Forked Repo

Youtube Tutorial

Features

  • Powerful and Very Useful built-in Plugins
    • gdrive [ upload / download / etc ] ( Team Drives Supported! )
    • zip / tar / unzip / untar / unrar
    • telegram upload / download
    • pmpermit / afk
    • notes / filters
    • split / combine
    • gadmin
    • plugin manager
    • ...and more
  • Channel & Group log support
  • Database support
  • Build-in help support
  • Easy to Setup & Use
  • Easy to add / port Plugins
  • Easy to write modules with the modified client

Example Plugin

from userge import userge, Message, filters

LOG = userge.getLogger(__name__)  # logger object
CHANNEL = userge.getCLogger(__name__)  # channel logger object

# add command handler
@userge.on_cmd("test", about="help text to this command")
async def test_cmd(message: Message):
   LOG.info("starting test command...")  # log to console
   # some other stuff
   await message.edit("testing...", del_in=5)  # this will be automatically deleted after 5 sec
   # some other stuff
   await CHANNEL.log("testing completed!")  # log to channel

# add filters handler
@userge.on_filters(filters.me & filters.private)  # filter my private messages
async def test_filter(message: Message):
   LOG.info("starting filter command...")
   # some other stuff
   await message.reply(f"you typed - {message.text}", del_in=5)
   # some other stuff
   await CHANNEL.log("filter executed!")

Project Credits

Copyright & License

GNU General Public License v3.0