Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.97 KB

README.md

File metadata and controls

49 lines (33 loc) · 1.97 KB
Raw

qbot

A plugin based, (user)bot framework for Telegram, somewhat inspired by otouto, and uniborg. For userbot plugins, see qserbot_plugins. For an api bot with more built-in plugins, see tanyabot

Requirements

  • Telethon 1.3
  • >= Python 3.5 (Tested on 3.6.6 and 3.7.0)
  • A brain probably

Built-In Functions

In Private

  • /ping
  • /start

Installation and Setup

  1. pip install -r requirements.txt
  2. cp example_config.ini config.ini
  3. Follow this link and login with your phone number
  4. A Create new application window will appear. Fill in your application details. There is no need to enter any URL, and only the first two fields (App title and Short name) can currently be changed later.
  5. Click on Create application at the end.
  6. Add your api id, api hash, and other information to config.ini
    • Create a bot with botfather if you need/want to
    • If you want a userbot; add your phone number to PHONE, if you want an api bot; add your bot token to TOKEN
  7. Start bot

Remember that your API hash is secret and Telegram won’t let you revoke it. Don’t post it anywhere!

start.sh creates a screen session called qbot. Check the logs by doing screen -r qbot. Detach from the session with ctrl a, d. Stop the bot with ctrl c.

Adding Custom Plugins

Create a new plugin file using the template {name}plugin.py. For example my_plugin.py.
from telethon import events, sync and from .global_functions import probability (optional) should be at the top. Then just add whatever you want. See this plugin as an example/template.