Skip to content

HyperUBot - A customizable, modular Telegram userbot, with innovative components.

License

Notifications You must be signed in to change notification settings

prototype74/HyperUBot

Repository files navigation

HyperUBot

A customizable, modular Telegram userbot, with innovative components.

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

Licensed under PEL

All rights reserved.

What is this?

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 community 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.

Compatibility

HyperUBot works with Linux based systems, macOS and Windows. It doesn't matter on which platform you'll setup HyperUBot, it's setup will be easy on all of them. However, at least Python v3.8 will be required regardless on which platform you want to host HyperUBot.

Supported platforms

  • Alpine Linux
  • Android (with Termux)
  • Arch Linux Based Distros (Arch Linux, Manjaro, etc.)
  • Debian Based Distros (Linux Mint, Ubuntu, etc.)
  • Docker* (Cloud platforms or local machine)
  • macOS (Catalina (10.15) or newer)
  • Red Hat Based Distros (AlmaLinux, Fedora, etc.)
  • Windows 10/11 (with PowerShell (5.0 or newer) or WSL)

* Docker will reset the environment after it's stopped which will also reset HyperUBot's saved data and settings. So it's recommended to use docker-volume or bind mounts to keep your data permanently.

Get HyperUBot

Get it for Androd/Linux/macOS Get it for Windows Setup in Docker

Important notice: Do not git clone the repository to install HyperUBot as changes pushed to the repository may not be stable for normal usage. Clone the project only if you want to take own changes to the source. Our stable releases are available in our Releases section which will be automatically picked by the installers in setup wiki and by the updater in userbot.

Read the wiki!

We made a GitHub wiki which should help users to understand more how HyperUBot works and which features it does offer. Feel free to check it out!

Reporting a bug

How to proper report a bug

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. Follow this guide to view or get the log.
Bugs or issues caused by user modules from HyperUBot's modules universe should be reported in it's Issues section.

What we don't accept as a bug

We DO NOT provide support, if the bug or issue was caused by modules from community repos or other type of modules e.g. ported modules from other userbots. Expect that we will ignore such bug reports if you report it anyway.

Support

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.

Maintainers

Credits

People, who also contributed to this project

Special thanks

Translators