MCUB-fork

MCUB-fork

Screenshots (click)

English

MCUB-fork is a Telegram userbot and a fork of MCUBFB with improved API and correct structure.

Tip

Module documentation: API documentation

Important

Recent Telethon-MCUB changes: CHANGELOG.md

Installation

Installation on different systems (click to expand)

Ubuntu / Debian

sudo apt update && sudo apt install -y python3 python3-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

Arch Linux

sudo pacman -S python python-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip install -r requirements.txt
python -m core

Fedora

sudo dnf install python3 python3-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

macOS

brew install python3 git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

Windows

# Using Python from Microsoft Store or python.org
git clone https://github.com/hairpin01/MCUB-fork.git
cd MCUB-fork
pip install -r requirements.txt
python -m core

Docker

# Build and run
docker build -t mcub-fork .
docker run -d -p 8080:8080 --name mcub mcub-fork

# Or use docker-compose
docker-compose up -d

Virtual Environment (recommended)

python3 -m venv .venv
source .venv/bin/activate  # Linux/macOS
# .venv\Scripts\activate   # Windows
pip install -r requirements.txt
python -m core

Configuration

Get API_ID and API_HASH from https://my.telegram.org
Run MCUB as a package:

python3 -m core

Fill in:
- api_id - your API ID
- api_hash - your API Hash
- phone - your phone number (+79991234567)

Tip

Sometimes you need to create a virtual environment (python -m venv .venv ; source .venv/bin/activate)

Important

The config.json file contains confidential data

Telethon-MCUB

MCUB-fork uses a custom fork of Telethon - Telethon-MCUB.

Install/upgrade: pip install -U telethon_mcub

CLI Flags

Flag	Description	Default	Environment Variable
`--no-web`	Disable the web panel	`false`	`MCUB_NO_WEB=1`
`--proxy-web`	Enable web proxy at specified path (e.g., `/web` or `/`)	-	`MCUB_PROXY_WEB=/web`
`--port`	Web panel port	`8080`	`MCUB_PORT=8080`
`--host`	Web panel host	`127.0.0.1`	`MCUB_HOST=127.0.0.1`
`--core`	Kernel core to use for this launch (e.g., `standard`, `zen`)	-	-
`--set-default-core`	Save a core as the default for future launches, then exit	-	-
`--clear-default-core`	Remove the saved default core, then exit	-	-

Examples

# Run with web panel disabled
python3 -m core --no-web

# Run on custom port
python3 -m core --port 9000

# Run with web proxy at /web path
python3 -m core --proxy-web=/web

# Run on all interfaces
python3 -m core --host 0.0.0.0

# Using environment variables
MCUB_NO_WEB=1 MCUB_PORT=9000 python3 -m core

# Run with the zen kernel core
python3 -m core --core zen

# Set zen as the default core for future launches
python3 -m core --set-default-core zen

# Clear the saved default core
python3 -m core --clear-default-core

Zen Kernel

Tip

The zen kernel core is a more stable alternative to standard. It receives updates less frequently, which means fewer regressions and a smoother experience for everyday use.

Then launch with:

# One-time launch
python3 -m core --core zen

# Or set as default so you never have to specify it again
python3 -m core --set-default-core zen
python3 -m core

Commands

.ping - check latency
.info - userbot info
.restart - restart
.iload - install module (reply to .py file)
.man [name/None] - list of modules (and their commands)
.um [name] - remove module

Tip

Security: Do NOT install suspicious modules. For security, there is api protection (to enable: .api_protection). Do not execute suspicious code using .py (python) or .t (terminal)

Note

To get HTML source of a message - just reply with .py print(r_text)

Modules

Modules are installed via the .iload command (reply to .py file). Module directory: modules_loaded/.

Support

Telegram chat click here

Official Repositories (`.dlm`)

Install: .dlm {module name / without arguments for all modules}

Module list (without inline bot): .dlm -list {module name / nothing}

Need a module for MCUB-fork? click here

Heroku / Hikka Module Support (beta)

Warning

This feature is in beta and not fully implemented. Not all Hikka modules will work correctly with MCUB-fork.

MCUB-fork has experimental support for Hikka/Heroku-style modules via Fheta (module searcher).

Install Fheta:

.dlm fheta-MCUB-repo

Search for modules:

.fheta [query]

or just use .dlm to browse available modules (MCUB-compatible modules).

Install a module from the repo:

.dlm [module name / URL]

Send a module to chat instead of installing:

.dlm -s [module name / URL]

Note

Only MCUB-compatible modules from the repo are guaranteed to work. Hikka modules may have unsupported APIs or dependencies.

Русский

MCUB-fork это userbot и форк MCUBFB с улучшенным API, и с правильной структурой.

Tip

документация по модулям: API Documentation

Установка

Установка на разные системы (нажмите чтобы раскрыть)

Ubuntu / Debian

sudo apt update && sudo apt install -y python3 python3-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

Arch Linux

sudo pacman -S python python-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip install -r requirements.txt
python -m core

Fedora

sudo dnf install python3 python3-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

macOS

brew install python3 git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

Windows

# Используя Python из Microsoft Store или python.org
git clone https://github.com/hairpin01/MCUB-fork.git
cd MCUB-fork
pip install -r requirements.txt
python -m core

Docker

# Собрать и запустить
docker build -t mcub-fork .
docker run -d -p 8080:8080 --name mcub mcub-fork

# Или через docker-compose
docker-compose up -d

Виртуальное окружение (рекомендуется)

python3 -m venv .venv
source .venv/bin/activate  # Linux/macOS
# .venv\Scripts\activate   # Windows
pip install -r requirements.txt
python -m core

Настройка

Получите API_ID и API_HASH на https://my.telegram.org
Запустите MCUB как пакет

python3 -m core

Заполните:
- api_id - ваш API ID
- api_hash - ваш API Hash
- phone - ваш номер телефона (+79991234567)

Tip

иногда нужно создать виртуальное окружение (python -m venv .venv ; source .venv/bin/activate)

Important

Файл config.json содержит конфиденциальные данные

Telethon-MCUB

MCUB-fork использует форк Telethon - Telethon-MCUB.

Установить/обновить: pip install -U telethon_mcub

Аргументы командной строки

Аргумент	Описание	По умолчанию	Переменная окружения
`--no-web`	Отключить веб-панель	`false`	`MCUB_NO_WEB=1`
`--proxy-web`	Включить прокси веба по указанному пути (например, `/web` или `/`)	-	`MCUB_PROXY_WEB=/web`
`--port`	Порт веб-панели	`8080`	`MCUB_PORT=8080`
`--host`	Хост веб-панели	`127.0.0.1`	`MCUB_HOST=127.0.0.1`
`--core`	Ядро для этого запуска (например, `standard`, `zen`)	-	-
`--set-default-core`	Сохранить ядро как дефолтное для будущих запусков и выйти	-	-
`--clear-default-core`	Удалить сохранённое дефолтное ядро и выйти	-	-

Примеры

# Запуск без веб-панели
python3 -m core --no-web

# Запуск на другом порту
python3 -m core --port 9000

# Запуск с прокси веба по пути /web
python3 -m core --proxy-web=/web

# Запуск на всех интерфейсах
python3 -m core --host 0.0.0.0

# Использование переменных окружения
MCUB_NO_WEB=1 MCUB_PORT=9000 python3 -m core

# Запуск с zen ядром
python3 -m core --core zen

# Сохранить zen как дефолтное ядро
python3 -m core --set-default-core zen

# Сбросить дефолтное ядро
python3 -m core --clear-default-core

Zen Ядро

Tip

zen — более стабильная альтернатива ядру standard. Обновляется реже, что означает меньше регрессий и плавнее работу в повседневном использовании.

Затем запустите:

# Разовый запуск
python3 -m core --core zen

# Или сохранить как дефолтное, чтобы больше не указывать вручную
python3 -m core --set-default-core zen
python3 -m core

Команды

.ping - проверка задержки
.info - информация о юзерботе
.restart - перезагрузка
.iload - установить модуль (ответ на .py файл)
.man - список модулей (и их команды)
.um [название] - удалить модуль

Tip

безопасность: НЕ устанавливайте подозрительные модули. для безопасности есть api protection (чтобы включить .api_protection). не исполняйте подозрительный код с помощью .py (python) или .t (терминал)

Note

чтобы получить html развёртку сообщения - просто ответом отправте .py print(r_text)

Модули

Модули устанавливаются через команду .iload (ответ на .py файл). Дириктория для модулей в modules_loaded/.

Поддержка

Чат в Telegram жмяк

Официальные репозитории (`.dlm`)

Установить: .dlm {название-модуля/без аргумента все модули}

Список модулей (без инлайн бота): .dlm -list {название модуля/нечего}

Нужен модуль для MCUB-fork? жмякни здесь

Поддержка модулей Heroku / Hikka (бета)

Warning

Функция находится в бета-версии и реализована не полностью. Не все модули Hikka будут корректно работать с MCUB-fork.

MCUB-fork имеет экспериментальную поддержку модулей в стиле Hikka/Heroku через Fheta (поисковик модулей).

Установить Fheta:

.dlm fheta-MCUB-repo

Поиск модулей:

.fheta [запрос]

или просто используйте .dlm для просмотра доступных модулей (MCUB-совместимые модули).

Установить модуль из репозитория:

.dlm [название модуля / URL]

Отправить модуль в чат вместо установки:

.dlm -s [название модуля / URL]

Note

Гарантированно работают только MCUB-совместимые модули из репозитория. Модули Hikka могут использовать неподдерживаемые API или зависимости.

Українська

MCUB-fork — це Telegram userbot та форк MCUBFB з покращеним API та правильною структурою.

Tip

Документація до модулів: API documentation

Встановлення

Встановлення на різні системи (натисніть щоб розгорнути)

Ubuntu / Debian

sudo apt update && sudo apt install -y python3 python3-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

Arch Linux

sudo pacman -S python python-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip install -r requirements.txt
python -m core

Fedora

sudo dnf install python3 python3-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

macOS

brew install python3 git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

Windows

# Використовуючи Python з Microsoft Store або python.org
git clone https://github.com/hairpin01/MCUB-fork.git
cd MCUB-fork
pip install -r requirements.txt
python -m core

Docker

# Збудувати та запустити
docker build -t mcub-fork .
docker run -d -p 8080:8080 --name mcub mcub-fork

# Або через docker-compose
docker-compose up -d

Віртуальне середовище (рекомендовано)

python3 -m venv .venv
source .venv/bin/activate  # Linux/macOS
# .venv\Scripts\activate   # Windows
pip install -r requirements.txt
python -m core

Налаштування

Отримайте API_ID та API_HASH на https://my.telegram.org
Запустіть MCUB як пакет:

python3 -m core

Заповніть:
- api_id — ваш API ID
- api_hash — ваш API Hash
- phone — ваш номер телефону (+79991234567)

Tip

Іноді потрібно створити віртуальне середовище (python -m venv .venv ; source .venv/bin/activate)

Important

Файл config.json містить конфіденційні дані

Telethon-MCUB

MCUB-fork використовує форк Telethon - Telethon-MCUB.

Встановити/оновити: pip install -U telethon_mcub

Параметри командного рядка

Параметр	Опис	За замовчуванням	Змінна середовища
`--no-web`	Вимкнути веб-панель	`false`	`MCUB_NO_WEB=1`
`--proxy-web`	Увімкнути проксі вебу за вказаним шляхом (наприклад, `/web` або `/`)	-	`MCUB_PROXY_WEB=/web`
`--port`	Порт веб-панелі	`8080`	`MCUB_PORT=8080`
`--host`	Хост веб-панелі	`127.0.0.1`	`MCUB_HOST=127.0.0.1`
`--core`	Ядро для цього запуску (наприклад, `standard`, `zen`)	-	-
`--set-default-core`	Зберегти ядро як типове для майбутніх запусків і вийти	-	-
`--clear-default-core`	Видалити збережене типове ядро і вийти	-	-

Приклади

# Запуск без веб-панелі
python3 -m core --no-web

# Запуск на іншому порту
python3 -m core --port 9000

# Запуск з проксі вебу за шляхом /web
python3 -m core --proxy-web=/web

# Запуск на всіх інтерфейсах
python3 -m core --host 0.0.0.0

# Використання змінних середовища
MCUB_NO_WEB=1 MCUB_PORT=9000 python3 -m core

# Запуск із zen ядром
python3 -m core --core zen

# Зберегти zen як типове ядро
python3 -m core --set-default-core zen

# Скинути типове ядро
python3 -m core --clear-default-core

Zen Ядро

Tip

zen — стабільніша альтернатива ядру standard. Оновлюється рідше, що означає менше регресій і плавнішу роботу щодня.

Потім запустіть:

# Одноразовий запуск
python3 -m core --core zen

# Або збережіть як типове, щоб більше не вказувати вручну
python3 -m core --set-default-core zen
python3 -m core

Команди

.ping — перевірка затримки
.info — інформація про юзербот
.restart — перезавантаження
.iload — встановити модуль (відповідь на .py файл)
.man — список модулів (та їх команди)
.um [назва] — видалити модуль

Tip

Безпека: НЕ встановлюйте підозрілі модулі. Для безпеки є api protection (щоб увімкнути: .api_protection). Не виконуйте підозрілий код за допомогою .py (python) або .t (термінал)

Note

Щоб отримати HTML-розгортку повідомлення — просто у відповідь надішліть .py print(r_text)

Модулі

Модулі встановлюються через команду .iload (відповідь на .py файл). Директорія для модулів: modules_loaded/.

Підтримка

Чат у Telegram натисніть тут

Офіційні репозиторії (`.dlm`)

Встановити: .dlm {назва-модуля/без аргументу всі модулі}

Список модулів (без інлайн бота): .dlm -list {назва модуля/нічого}

Потрібен модуль для MCUB-fork? натисніть тут

Підтримка модулів Heroku / Hikka (бета)

Warning

Функція перебуває в бета-версії і реалізована не повністю. Не всі модулі Hikka коректно працюватимуть з MCUB-fork.

MCUB-fork має експериментальну підтримку модулів у стилі Hikka/Heroku через Fheta (пошуковик модулів).

Встановити Fheta:

.dlm fheta-MCUB-repo

Пошук модулів:

.fheta [запит]

або просто використовуйте .dlm для перегляду доступних модулів (MCUB-сумісні модулі).

Встановити модуль з репозиторію:

.dlm [назва модуля / URL]

Надіслати модуль у чат замість встановлення:

.dlm -s [назва модуля / URL]

Note

Гарантовано працюють лише MCUB-сумісні модулі з репозиторію. Модулі Hikka можуть використовувати непідтримувані API або залежності.

Español

MCUB-fork es un userbot de Telegram y un fork de MCUBFB con API mejorada y estructura correcta.

Tip

Documentación de módulos: API documentation

Instalación

Instalación en diferentes sistemas (clic para expandir)

Ubuntu / Debian

sudo apt update && sudo apt install -y python3 python3-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

Arch Linux

sudo pacman -S python python-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip install -r requirements.txt
python -m core

Fedora

sudo dnf install python3 python3-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

macOS

brew install python3 git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

Windows

# Usando Python desde Microsoft Store o python.org
git clone https://github.com/hairpin01/MCUB-fork.git
cd MCUB-fork
pip install -r requirements.txt
python -m core

Docker

# Construir y ejecutar
docker build -t mcub-fork .
docker run -d -p 8080:8080 --name mcub mcub-fork

# O usar docker-compose
docker-compose up -d

Entorno virtual (recomendado)

python3 -m venv .venv
source .venv/bin/activate  # Linux/macOS
# .venv\Scripts\activate   # Windows
pip install -r requirements.txt
python -m core

Configuración

Obtén API_ID y API_HASH de https://my.telegram.org
Ejecuta MCUB como paquete:

python3 -m core

Rellena:
- api_id - tu API ID
- api_hash - tu API Hash
- phone - tu número de teléfono (+79991234567)

Tip

A veces necesitas crear un entorno virtual (python -m venv .venv ; source .venv/bin/activate)

Important

El archivo config.json contiene datos confidenciales

Telethon-MCUB

MCUB-fork usa un fork de Telethon - Telethon-MCUB.

Instalar/actualizar: pip install -U telethon_mcub

Banderas CLI

Bandera	Descripción	Por defecto	Variable de entorno
`--no-web`	Desactivar el panel web	`false`	`MCUB_NO_WEB=1`
`--proxy-web`	Activar proxy web en la ruta especificada (ej. `/web` o `/`)	-	`MCUB_PROXY_WEB=/web`
`--port`	Puerto del panel web	`8080`	`MCUB_PORT=8080`
`--host`	Host del panel web	`127.0.0.1`	`MCUB_HOST=127.0.0.1`
`--core`	Núcleo del kernel para este lanzamiento (ej. `standard`, `zen`)	-	-
`--set-default-core`	Guardar un núcleo como predeterminado para futuros lanzamientos y salir	-	-
`--clear-default-core`	Eliminar el núcleo predeterminado guardado y salir	-	-

Ejemplos

# Ejecutar sin panel web
python3 -m core --no-web

# Ejecutar en puerto personalizado
python3 -m core --port 9000

# Ejecutar con proxy web en /web
python3 -m core --proxy-web=/web

# Ejecutar en todas las interfaces
python3 -m core --host 0.0.0.0

# Usando variables de entorno
MCUB_NO_WEB=1 MCUB_PORT=9000 python3 -m core

# Ejecutar con el núcleo zen
python3 -m core --core zen

# Establecer zen como núcleo predeterminado
python3 -m core --set-default-core zen

# Limpiar el núcleo predeterminado
python3 -m core --clear-default-core

Núcleo Zen

Tip

El núcleo zen es una alternativa más estable a standard. Se actualiza con menos frecuencia, lo que significa menos regresiones y una experiencia más fluida.

Luego ejecuta:

# Lanzamiento único
python3 -m core --core zen

# O establecer como predeterminado para no tener que especificarlo más
python3 -m core --set-default-core zen
python3 -m core

Comandos

.ping - verificar latencia
.info - información del userbot
.restart - reiniciar
.iload - instalar módulo (responder a archivo .py)
.man - lista de módulos (y sus comandos)
.um [nombre] - eliminar módulo

Tip

Seguridad: NO instales módulos sospechosos. Para seguridad existe api protection (para activar: .api_protection). No ejecutes código sospechoso usando .py (python) o .t (terminal)

Note

Para obtener el código HTML de un mensaje - solo responde con .py print(r_text)

Módulos

Los módulos se instalan mediante el comando .iload (responder a archivo .py). Directorio de módulos: modules_loaded/.

Soporte

Chat de Telegram haz clic aquí

Repositorios Oficiales (`.dlm`)

Instalar: .dlm {nombre-del-módulo / sin argumentos para todos los módulos}

Lista de módulos (sin bot inline): .dlm -list {nombre-del-módulo / nada}

¿Necesitas un módulo para MCUB-fork? haz clic aquí

Soporte de módulos Heroku / Hikka (beta)

Warning

Esta función está en beta y no está completamente implementada. No todos los módulos de Hikka funcionarán correctamente con MCUB-fork.

MCUB-fork tiene soporte experimental para módulos estilo Hikka/Heroku a través de Fheta (buscador de módulos).

Instalar Fheta:

.dlm fheta-MCUB-repo

Buscar módulos:

.fheta [consulta]

o simplemente usa .dlm para explorar los módulos disponibles (módulos compatibles con MCUB).

Instalar un módulo del repositorio:

.dlm [nombre del módulo / URL]

Enviar un módulo al chat en lugar de instalarlo:

.dlm -s [nombre del módulo / URL]

Note

Solo se garantiza que funcionen los módulos compatibles con MCUB del repositorio. Los módulos de Hikka pueden tener APIs o dependencias no compatibles.

Deutsch

MCUB-fork ist ein Telegram-Userbot und ein Fork von MCUBFB mit verbesserter API und korrekter Struktur.

Tip

Moduldokumentation: API documentation

Installation

Installation auf verschiedenen Systemen (klicken zum Erweitern)

Ubuntu / Debian

sudo apt update && sudo apt install -y python3 python3-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

Arch Linux

sudo pacman -S python python-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip install -r requirements.txt
python -m core

Fedora

sudo dnf install python3 python3-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

macOS

brew install python3 git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

Windows

# Python von Microsoft Store oder python.org verwenden
git clone https://github.com/hairpin01/MCUB-fork.git
cd MCUB-fork
pip install -r requirements.txt
python -m core

Docker

# Builden und ausführen
docker build -t mcub-fork .
docker run -d -p 8080:8080 --name mcub mcub-fork

# Oder docker-compose verwenden
docker-compose up -d

Virtuelle Umgebung (empfohlen)

python3 -m venv .venv
source .venv/bin/activate  # Linux/macOS
# .venv\Scripts\activate   # Windows
pip install -r requirements.txt
python -m core

Konfiguration

Erhalte API_ID und API_HASH von https://my.telegram.org
MCUB als Paket ausführen:

python3 -m core

Ausfüllen:
- api_id - deine API ID
- api_hash - dein API Hash
- phone - deine Telefonnummer (+79991234567)

Tip

Manchmal musst du eine virtuelle Umgebung erstellen (python -m venv .venv ; source .venv/bin/activate)

Important

Die config.json Datei enthält vertrauliche Daten

Telethon-MCUB

MCUB-fork verwendet einen Fork von Telethon - Telethon-MCUB.

Installieren/Aktualisieren: pip install -U telethon_mcub

CLI-Flags

Flag	Beschreibung	Standard	Umgebungsvariable
`--no-web`	Webpanel deaktivieren	`false`	`MCUB_NO_WEB=1`
`--proxy-web`	Webproxy unter dem angegebenen Pfad aktivieren (z.B. `/web` oder `/`)	-	`MCUB_PROXY_WEB=/web`
`--port`	Webpanel-Port	`8080`	`MCUB_PORT=8080`
`--host`	Webpanel-Host	`127.0.0.1`	`MCUB_HOST=127.0.0.1`
`--core`	Kernel-Core für diesen Start (z.B. `standard`, `zen`)	-	-
`--set-default-core`	Core als Standard für zukünftige Starts speichern und beenden	-	-
`--clear-default-core`	Gespeicherten Standard-Core entfernen und beenden	-	-

Beispiele

# Ohne Webpanel ausführen
python3 -m core --no-web

# Auf benutzerdefiniertem Port ausführen
python3 -m core --port 9000

# Mit Webproxy unter /web ausführen
python3 -m core --proxy-web=/web

# Auf allen Interfaces ausführen
python3 -m core --host 0.0.0.0

# Umgebungsvariablen verwenden
MCUB_NO_WEB=1 MCUB_PORT=9000 python3 -m core

# Mit dem zen-Kernel-Core starten
python3 -m core --core zen

# Zen als Standard-Core festlegen
python3 -m core --set-default-core zen

# Standard-Core zurücksetzen
python3 -m core --clear-default-core

Zen-Kernel

Tip

Der zen-Kernel ist eine stabilere Alternative zu standard. Er wird seltener aktualisiert, was weniger Regressionen und eine reibungslosere Nutzung bedeutet.

Dann starten:

# Einmaliger Start
python3 -m core --core zen

# Oder als Standard festlegen, damit man ihn nicht mehr angeben muss
python3 -m core --set-default-core zen
python3 -m core

Befehle

.ping - Latenz prüfen
.info - Userbot-Info
.restart - Neustart
.iload - Modul installieren (auf .py Datei antworten)
.man - Modulliste (und ihre Befehle)
.um [name] - Modul entfernen

Tip

Sicherheit: Installiere KEINE verdächtigen Module. Für Sicherheit gibt es API-Schutz (aktivieren mit: .api_protection). Führe keinen verdächtigen Code mit .py (Python) oder .t (Terminal) aus

Note

Um die HTML-Quelle einer Nachricht zu erhalten - antworte einfach mit .py print(r_text)

Module

Module werden über den .iload Befehl installiert (auf .py Datei antworten). Modulverzeichnis: modules_loaded/.

Support

Telegram-Chat hier klicken

Offizielle Repositories (`.dlm`)

Installieren: .dlm {Modulname / ohne Argumente für alle Module}

Modulliste (ohne Inline-Bot): .dlm -list {Modulname / nichts}

Brauchst du ein Modul für MCUB-fork? hier klicken

Heroku / Hikka Modulunterstützung (Beta)

Warning

Diese Funktion befindet sich in der Beta-Phase und ist noch nicht vollständig implementiert. Nicht alle Hikka-Module werden mit MCUB-fork korrekt funktionieren.

MCUB-fork hat experimentelle Unterstützung für Hikka/Heroku-Module über Fheta (Modulsucher).

Fheta installieren:

.dlm fheta-MCUB-repo

Module suchen:

.fheta [Suchanfrage]

oder verwende einfach .dlm, um verfügbare Module zu durchsuchen (MCUB-kompatible Module).

Modul aus dem Repository installieren:

.dlm [Modulname / URL]

Modul in den Chat senden statt installieren:

.dlm -s [Modulname / URL]

Note

Nur MCUB-kompatible Module aus dem Repository sind garantiert funktionsfähig. Hikka-Module können nicht unterstützte APIs oder Abhängigkeiten haben.

中文

MCUB-fork 是一个 Telegram 用户机器人，是 MCUBFB 的分支，具有改进的 API 和正确的结构。

Tip

模块文档：API 文档

安装

在不同系统上安装（点击展开）

Ubuntu / Debian

sudo apt update && sudo apt install -y python3 python3-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

Arch Linux

sudo pacman -S python python-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip install -r requirements.txt
python -m core

Fedora

sudo dnf install python3 python3-pip git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

macOS

brew install python3 git
git clone https://github.com/hairpin01/MCUB-fork.git && cd MCUB-fork
pip3 install -r requirements.txt
python3 -m core

Windows

# 使用 Microsoft Store 或 python.org 的 Python
git clone https://github.com/hairpin01/MCUB-fork.git
cd MCUB-fork
pip install -r requirements.txt
python -m core

Docker

# 构建并运行
docker build -t mcub-fork .
docker run -d -p 8080:8080 --name mcub mcub-fork

# 或使用 docker-compose
docker-compose up -d

虚拟环境（推荐）

python3 -m venv .venv
source .venv/bin/activate  # Linux/macOS
# .venv\Scripts\activate   # Windows
pip install -r requirements.txt
python -m core

配置

从 https://my.telegram.org 获取 API_ID 和 API_HASH
以包形式运行 MCUB：

python3 -m core

填写：
- api_id - 你的 API ID
- api_hash - 你的 API Hash
- phone - 你的电话号码 (+79991234567)

Tip

有时需要创建虚拟环境（python -m venv .venv ; source .venv/bin/activate）

Warning

config.json 文件包含敏感数据

Telethon-MCUB

MCUB-fork 使用 Telethon 的分支版本 - Telethon-MCUB。

安装/更新: pip install -U telethon_mcub

CLI 参数

参数	描述	默认值	环境变量
`--no-web`	禁用网页面板	`false`	`MCUB_NO_WEB=1`
`--proxy-web`	在指定路径启用网页代理（例如 `/web` 或 `/`）	-	`MCUB_PROXY_WEB=/web`
`--port`	网页面板端口	`8080`	`MCUB_PORT=8080`
`--host`	网页面板主机	`127.0.0.1`	`MCUB_HOST=127.0.0.1`
`--core`	本次启动使用的内核（例如 `standard`、`zen`）	-	-
`--set-default-core`	将内核保存为未来启动的默认值后退出	-	-
`--clear-default-core`	删除已保存的默认内核后退出	-	-

示例

# 禁用网页面板运行
python3 -m core --no-web

# 自定义端口运行
python3 -m core --port 9000

# 在 /web 路径启用网页代理
python3 -m core --proxy-web=/web

# 在所有接口上运行
python3 -m core --host 0.0.0.0

# 使用环境变量
MCUB_NO_WEB=1 MCUB_PORT=9000 python3 -m core

# 使用 zen 内核运行
python3 -m core --core zen

# 将 zen 设置为默认内核
python3 -m core --set-default-core zen

# 清除默认内核
python3 -m core --clear-default-core

Zen 内核

Tip

zen 内核是 standard 的更稳定替代方案。它更新频率更低，意味着更少的回归问题和更流畅的日常使用体验。

然后启动：

# 单次启动
python3 -m core --core zen

# 或设为默认，以后无需再次指定
python3 -m core --set-default-core zen
python3 -m core

命令

.ping - 检查延迟
.info - 用户机器人信息
.restart - 重启
.iload - 安装模块 (回复 .py 文件)
.man - 模块列表 (及其命令)
.um [名称] - 删除模块

Warning

安全： 不要安装__可疑__模块。为了安全，有 API 保护（启用：.api_protection）。不要使用 .py（Python）或 .t（终端）执行可疑代码

Note

要获取消息的 HTML 源码 - 只需回复 .py print(r_text)

模块

模块通过 .iload 命令安装（回复 .py 文件）。模块目录：modules_loaded/。

支持

Telegram 群组 点击这里

官方仓库（`.dlm`）

安装：.dlm {模块名称 / 无参数则安装所有模块}

模块列表 (无内联机器人)：.dlm -list {模块名称 / 无}

需要 MCUB-fork 的模块？ 点击这里

Heroku / Hikka 模块支持（测试版）

Warning

此功能处于测试阶段，尚未完全实现。并非所有 Hikka 模块都能与 MCUB-fork 正常配合使用。

MCUB-fork 通过 Fheta（模块搜索器）实验性地支持 Hikka/Heroku 风格的模块。

安装 Fheta：

.dlm fheta-MCUB-repo

搜索模块：

.fheta [搜索关键词]

或直接使用 .dlm 浏览可用模块 （MCUB 兼容模块）。

从仓库安装模块：

.dlm [模块名称 / URL]

将模块发送到聊天而非安装：

.dlm -s [模块名称 / URL]

Note

仅保证仓库中与 MCUB 兼容的模块正常工作。Hikka 模块可能使用不受支持的 API 或依赖项。

Name		Name	Last commit message	Last commit date
Latest commit History 879 Commits
.github/workflows		.github/workflows
core		core
core_inline		core_inline
img		img
modules		modules
tests		tests
utils		utils
.dockerignore		.dockerignore
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
API_DOC.md		API_DOC.md
Dockerfile		Dockerfile
README.md		README.md
config.example.json		config.example.json
docker-compose.yml		docker-compose.yml
pyproject.toml		pyproject.toml
requirements.txt		requirements.txt
version.txt		version.txt

Folders and files

Latest commit

History

Repository files navigation

MCUB-fork

English

Installation

Ubuntu / Debian

Arch Linux

Fedora

macOS

Windows

Docker

Virtual Environment (recommended)

Configuration

Telethon-MCUB

CLI Flags

Examples

Zen Kernel

Commands

Modules

Support

Official Repositories (.dlm)

Heroku / Hikka Module Support (beta)

Русский

Установка

Ubuntu / Debian

Arch Linux

Fedora

macOS

Windows

Docker

Виртуальное окружение (рекомендуется)

Настройка

Telethon-MCUB

Аргументы командной строки

Примеры

Zen Ядро

Команды

Модули

Поддержка

Официальные репозитории (.dlm)

Поддержка модулей Heroku / Hikka (бета)

Українська

Встановлення

Ubuntu / Debian

Arch Linux

Fedora

macOS

Windows

Docker

Віртуальне середовище (рекомендовано)

Налаштування

Telethon-MCUB

Параметри командного рядка

Приклади

Zen Ядро

Команди

Модулі

Підтримка

Офіційні репозиторії (.dlm)

Підтримка модулів Heroku / Hikka (бета)

Español

Instalación

Ubuntu / Debian

Arch Linux

Fedora

macOS

Windows

Docker

Entorno virtual (recomendado)

Configuración

Telethon-MCUB

Banderas CLI

Ejemplos

Núcleo Zen

Comandos

Módulos

Soporte

Repositorios Oficiales (.dlm)

Official Repositories (`.dlm`)

Официальные репозитории (`.dlm`)

Офіційні репозиторії (`.dlm`)

Repositorios Oficiales (`.dlm`)

Offizielle Repositories (`.dlm`)

官方仓库（`.dlm`）

Heroku / Hikka 模块支持（测试版）