38 lines
1.1 KiB
Markdown
38 lines
1.1 KiB
Markdown
# OverUB
|
|
|
|
OverUB is a modular Telegram userbot built around a plugin-first architecture.
|
|
|
|
## Quick Start
|
|
1. Install dependencies: `pip install -r requirements.txt`
|
|
- Optional for QR display: `pip install qrcode`
|
|
2. Edit `config/config.yml`
|
|
3. Run: `python -m __main__`
|
|
4. Optional login modes:
|
|
- `phone` (default)
|
|
- `qr` (QR login)
|
|
- `sms` (force SMS code)
|
|
5. Optional: set `bot.session_string` or `OVERUB_SESSION_STRING` to use a Telethon StringSession
|
|
6. Optional: import Telegram Desktop session:
|
|
- `pip install opentele`
|
|
- `python scripts/import-tdata.py --tdata /path/to/tdata`
|
|
|
|
## 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`
|