README.md

Pluggable Telegram UserBot
Inspiration  •  Features  •  Example  •  Requirements  •  Project Credits  •  Copyright & License

Userge 🔥

Userge is a Powerful , Pluggable Telegram UserBot written in Python using Pyrogram.

Inspiration 😇

This project is inspired by the following projects :)

• tg_userbot ( heavily ) 🤗
• PyroGramUserBot
• Telegram-Paperplane
• UniBorg

Special Thanks to all of you !!!.

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
  • etc...
• 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

LOG = userge.getLogger(__name__)  # logger object

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

@userge.on_cmd("test", about="help text to this command")  # adding handler and help text to .test command
async def testing(message: Message):
   LOG.info("starting test command...")  # log to console

   await message.edit("testing...", del_in=5)  # this will be automatically deleted after 5 sec

   await CHANNEL.log("testing completed!")  # log to channel

Requirements 🥴

• Python 3.8 or Higher 👻
• Telegram API Keys
• Google Drive API Keys
• MongoDB Database URL

How To Deploy 👷

• HEROKU Method 🔧

  First click the button below.

  If you don't have HU_STRING_SESSION just ignore it.

  After Deployed to Heroku first turn off the app (resources -> turn off) and run bash genStr in console (more -> run console).

  After that copy the string session and past it in Config Vars (settings -> reveal config vars).

  Finally turn on the app and check the logs (settings -> view logs) :)

  

• Other Method 🔧

  # clone the repo
  git clone https://github.com/UsergeTeam/Userge.git
  cd Userge
  
  # 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 ;)
  bash run

• More Detailed Guide 📝

Run on Docker 🐳

1. Install Docker ( Guide )
2. Clone the repo git clone https://github.com/UsergeTeam/Userge.git
3. cd Userge
4. Create the docker image docker build -t userge .
5. cd ..
6. wget https://raw.githubusercontent.com/UsergeTeam/Userge/alpha/config.env.sample -O config.env
7. Edit the file with your text editor vi config.env
8. Finally run the container docker run -dv "$(pwd)/config.env:/app/config.env" userge

Video Tutorial 🎥

Support & Discussions 👥

Head over to the Discussion Group and Update Channel

Project Credits 💆‍♂️

• Specially to these projects 🥰
• @uaudIth
• @K_E_N_W_A_Y
• @nawwasl
• @TharukaN97
• @Supun97
• @gotstc

Copyright & License 👮

• Copyright (C) 2020 by UsergeTeam ❤️️
• Licensed under the terms of the GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007