overub/README.md

OverUB

OverUB is a modular Telegram userbot built around a plugin-first architecture.

Quick Start

1. Install dependencies: pip install -r requirements.txt
2. Edit config/config.yml
3. Run: python -m __main__
4. Optional: set bot.login_mode to qr for QR login

CLI

• python -m __main__ create-plugin <name>
• python -m __main__ validate-plugin <path>
• python -m __main__ build-plugin <path>
• python -m __main__ docs-plugin <path>
• python -m __main__ test-plugin <path>

Structure

See the core/ package for the minimal base runtime and modules/ for built-ins.

Tests

• python -m unittest discover -s tests

Docs

• docs/PLUGIN_GUIDE.md
• docs/API_REFERENCE.md
• docs/EXAMPLES.md
• docs/BEST_PRACTICES.md
• docs/GITEA_SETUP.md