A customizable, modular Telegram userbot, with innovative components.

Copyright (C) 2020-2021 nunopenim
Copyright (C) 2020-2021 prototype74

Licensed under PEL

All rights reserved.

HyperUBot is a modular Telegram userbot written in Python which uses Telethon's API library by LonamiWebs. It does not require any form of database. It has support to be fully translatable, contains it's own package manager, with an official repo and the possibility to configure multiple extra community repos. It contains also a sideloader for .py files sent in chat. The aim of this userbot is to become an extension of it's own user. Instead of coming cluttered with all kinds of packages, it is fully customizable, aiming to be fast.

HyperUBot works with Windows (PowerShell and WSL), macOS, Linux (Ubuntu, Arch linux etc.) and Android. Cloud platforms like Heroku are not supported, due to the way how these platforms handle bash processes, something needed for some bash based commands.

We recommend using Ubuntu 18.04 or 20.04, as it's setup is a lot easier, and straight forward (there is no need of installing a package manager, such as apt-get, since it comes by default.)

There are 3 basic commands which users of HyperUBot should know about. These commands can be used in any chat by typing:

.status - Get the current status of HyperUBot such as the version, uptime etc. Useful to check if the bot is actually online.
.listcmds (or .help) - lists all available commands and features from all modules to use. Pass the name of a command or feature (e.g. .help status) to get the usage of the certain command or feature.
.modules - lists all built-in and user modules at one place. .modules takes arguments to get further information of a module such as the description or usage.

A bug report can be done either in the Issues section of this repository or in our Telegram Support Group. In order to solve the bug or issue report from you as fast as possible, please answer the following requirements as detailed as possible (this can be used as a template):

• Which HyperUBot, Python and Telethon versions are you running?
• On which platform(s) did you run it?
• Describe the bug or issue as good as possible
• Provide the log which the bot did generate!

HyperUBot generates a log hyper.log in the bot's root directory automatically everytime you run the bot. Please provide us this log, as it helps us a lot to figure out the bug or issue faster.
Bugs or issues caused in user modules from HyperUBot's modules universe should be reported in it's Issues section.

We only provide support, if the bug or issue was NOT caused by third party modules or sources, that means only bugs that are caused from HyperUBot's official sources. Bugs caused by non-official sources for example from sideloads are irrelevant and will be ignored (or closed in Issues section)

A small, introductory guide in how to develop your modules can be found here. This explains the basics in how to setup your module's .py file, so that HyperUBot can load it and run it when it is called.

Currently we have a News Channel (Click to join). Here you can find news about bot updates, changes in modules and releases in the module-universe.

We also have a Support Group (Click to join), where we will be there to discuss about the bot, fix some issues, and help you set up the bot, if you are stuck in a specific step.

• nunopenim
• prototype74

• KebapciEBY, for the support and ideas he gave during development.

• nunopenim, for the Portuguese translation
• prototype74, for the German translation