UniBorg

by Dark-Princ3

GitHub Readme.md

uniborg

Pluggable asyncio Telegram userbot based on Telethon.

installing

The Easy Ways

Deploy

The Legacy Way

Simply clone the repository and run the main file:

git clone https://github.com/uniborg/uniborg.git
cd uniborg
virtualenv -p /usr/bin/python3 venv
. ./venv/bin/activate
pip install -r requirements.txt
# <Create config.py with variables as given below>
python3 -m stdborg

An example config.py file could be:

Not All of the variables are mandatory

The UniBorg should work by setting only the first two variables

from sample_config import Config

class Development(Config):
  APP_ID = 6
  API_HASH = "eb06d4abfb49dc3eeb1aeb98ae0f581e"
  TG_BOT_TOKEN_BF_HER = ""
  TG_BOT_USER_NAME_BF_HER = ""
  UB_BLACK_LIST_CHAT = []
  # chat ids or usernames, it is recommended to use chat ids,
  # providing usernames means an additional overhead for the user
  CHATS_TO_MONITOR_FOR_ANTI_FLOOD = []
  # specify LOAD and NO_LOAD
  LOAD = []
  NO_LOAD = []

internals

The core features offered by the custom TelegramClient live under the uniborg/ directory, with some utilities, enhancements, the _core plugin, and the _inline_bot plugin.

@SpEcHlDe

  • Only two of the environment variables are mandatory.
  • This is because of telethon.errors.rpc_error_list.ApiIdPublishedFloodError
  • The userbot will work without setting the non-mandatory environment variables.
  • Please report any issues to the support group: @SpEcHlDe

design

The modular design of the project enhances your Telegram experience through plugins which you can enable or disable on demand.

Each plugin gets the borg, logger, Config, tgbot magical variables to ease their use. Thus creating a plugin as easy as adding a new file under the plugin directory to do the job:

# stdplugins/myplugin.py
from telethon import events
from uniborg.util import admin_cmd
@borg.on(admin_cmd(pattern="hi"))
async def handler(event):
    await event.reply("hey")

learning

Check out the already-mentioned plugins directory, or some third-party plugins to learn how to write your own, and consider reading Telethon's documentation.

credits

Thanks to: