Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/code-rgb/USERGE-X

USERGE-X. What the X ?
https://github.com/code-rgb/USERGE-X

bot heroku inline pyrogram python3 telegram userbot

Last synced: about 2 months ago
JSON representation

USERGE-X. What the X ?

Host: GitHub
URL: https://github.com/code-rgb/USERGE-X
Owner: code-rgb
License: gpl-3.0
Archived: true
Created: 2020-08-10T11:13:24.000Z (about 4 years ago)
Default Branch: alpha
Last Pushed: 2021-05-14T08:52:22.000Z (over 3 years ago)
Last Synced: 2024-06-12T08:11:31.898Z (3 months ago)
Topics: bot, heroku, inline, pyrogram, python3, telegram, userbot
Language: Python
Homepage: https://del.dog/userge-x
Size: 5.91 MB
Stars: 128
Watchers: 7
Forks: 473
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        
Owner: 𝚂𝚢𝚗𝚝𝚊𝚡 ░ Σrr♢r






   

   


   




USERGE-X

Pluggable Telegram UserBot







[![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.png?v=103)](https://github.com/code-rgb/userge-x)

[![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg?&style=flat-square)](https://github.com/code-rgb/USERGE-X#copyright--license)

[![Stars](https://img.shields.io/github/stars/code-rgb/USERGE-X?&style=flat-square)](https://github.com/code-rgb/USERGE-X/stargazers)

[![Forks](https://img.shields.io/github/forks/code-rgb/USERGE-X?&style=flat-square)](https://github.com/code-rgb/USERGE-X/network/members)

[![Issues Open](https://img.shields.io/github/issues/code-rgb/USERGE-X?&style=flat-square)](https://github.com/code-rgb/USERGE-X/issues)

[![Issues Closed](https://img.shields.io/github/issues-closed/code-rgb/USERGE-X?&style=flat-square)](https://github.com/code-rgb/USERGE-X/issues?q=is:closed)

[![PR Open](https://img.shields.io/github/issues-pr/code-rgb/USERGE-X?&style=flat-square)](https://github.com/code-rgb/USERGE-X/pulls)

[![PR Closed](https://img.shields.io/github/issues-pr-closed/code-rgb/USERGE-X?&style=flat-square)](https://github.com/code-rgb/USERGE-X/pulls?q=is:closed)

![Repo Size](https://img.shields.io/github/repo-size/code-rgb/userge-x?style=flat-square)

[![CodeFactor](https://www.codefactor.io/repository/github/code-rgb/userge-x/badge?&style=flat-square)](https://www.codefactor.io/repository/github/code-rgb/userge-x)

[![DeepSource](https://deepsource.io/gh/code-rgb/userge-x.svg/?label=active+issues&show_trend=true)](https://deepsource.io/gh/code-rgb/userge-x/?ref=repository-badge)

[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod&style=flat-square)](https://gitpod.io/#https://github.com/code-rgb/userge-x)

[![Docker Image](https://img.shields.io/docker/image-size/varietyjames1/userge_x?color=blue&label=Docker%20Size&style=flat-square&logo=docker&logoColor=white)](https://hub.docker.com/r/varietyjames1/userge_x/tags?page=1&ordering=last_updated)




**USERGE-X** is a Powerful , _Pluggable_ Telegram UserBot written in _Python_ using [Pyrogram](https://github.com/pyrogram/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 

* Python 3.8 or Higher

* Telegram [API Keys](https://my.telegram.org/apps)

* Google Drive [API Keys](https://console.developers.google.com/)

* MongoDB [Database URL](https://cloud.mongodb.com/)

## How To Deploy 

* With Heroku:



   






> **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](https://telegra.ph/Heroku-Vars-for-USERGE-X-08-25) later

* Finally **hit deploy** button

## String Session

**VAR ->** `HU_STRING_SESSION`

#### By HEROKU

- [open your app](https://dashboard.heroku.com/apps/) then go to **more** -> **run console** and type `bash genStr` and click **run**.

#### On REPL

- [Generate on REPL](https://repl.it/@Leorio/stringsessiongen#main.py)

### Read more

  Details and Guides

## Other Ways

* With Docker 🐳 

    See Detailed Guide

* With Git, Python and pip 🔧

  ```bash

  # 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 

```python

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 

* [Pyrogram Assistant](https://github.com/pyrogram/assistant)

* [PyroGramBot](https://github.com/SpEcHiDe/PyroGramBot)

* [PaperPlane](https://github.com/RaphielGang/Telegram-Paperplane)

* [Uniborg](https://github.com/SpEcHiDe/UniBorg)

### Copyright & License 

[**GNU General Public License v3.0**](https://github.com/code-rgb/USERGE-X/blob/alpha/LICENSE)