Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alemidev/abot

my Telegram (user)bot framework
https://github.com/alemidev/abot

bot pyrogram python telegram userbot

Last synced: 3 months ago
JSON representation

my Telegram (user)bot framework

Awesome Lists containing this project

README 

        
# aBot

**Telegram bot/userbot framework**



This repo contains the root for abot:

* `core` plugin

* utils

* config file

* folders



### Features

* a centralized config file

* a command parsing system (UNIX-like) to implement sophisticated commands

* an help command which automatically extracts docstrings

* a 2 role permission system (user/root)

* a wrapper around pyrogram SQLite db, for easy storage of persistent data

* some common commands (/update, /ping, /info)

* events for bot startup/shutdown

* some utility functions to handle most common tasks

* a plugin manager (with git submodules), allowing plugins to access all above features



aBot simplifies my bot development, by providing a standardized and solid baseline, with common features to all projects, which can focus on their specific functionalities.



# Some plugins

* `https://git.alemi.dev/abot/debugtool.git` very useful tools for debugging and interacting with server

* `https://git.alemi.dev/abot/tricks.git` my biggest collection of "trick command": fancy stuff to show off

* `https://git.alemi.dev/abot/moderation.git` a powerful purge command, to precisely delete messages, plus a small censor utility

* `https://git.alemi.dev/abot/statsbot.git` a powerful tracker bot to log your group stats or provide fun insights

* ... more to come, send me your plugins!



## Making custom plugins

To develop your own plugins for aBot, you should clone first this repository and work in a folder in the `plugins` directory.

Each plugin must be a repository itself which can be installed in the `plugins` folder as a submodule.



**One "catch":** your plugin should import its files as `import plugins..<...>`. This means that if you need to have custom classes, you cannot have dashes (`-`) in your plugin name. Thinking about solutions... On the flip side, you can always access utils



# How to deploy

You just need Python 3.7+ and a PC always on to run this. More dependancies will depend on modules.

It is strongly recommended to install this on a UNIX system. If you plan to install on Windows, [I recommend installing abot inside a WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10)

* Clone this repo : `git clone https://git.alemi.dev/abot/core.git abot`

* Make a `venv` with `python3 -m venv `

* Activate `venv` with `source /bin/activate`

* Install the `abot` package in your new venv: `pip install ./abot`

* Copy `default.ini` to another file (`my-bot.ini`, for example, use any name) and fill in your API hash and ID (visit https://my.telegram.org/)

* Run bot : `python -m abot my-bot`, pass your config name as argument. First time it will request your phone number and a verification code.



# config file

Only required fields are `api_id` and `api_hash`. There is an example config file (`default.ini`) where you just need to fill `api_id` and `api_hash`.

Multiple bot instances can be run with just 1 installation: just give unique names to your configurations and run the correct one: `python -m abot `.



```ini

[pyrogram]

api_id = 1234                     # your API ID

api_hash = longstring             # your API hash

[perms]

sudo = 0                          # users allowed to operate this account as sudo. Put ids, separate with whitespace

public = False                    # commands for allowed users will be available to everyone

allowPlugins = True               # allow superusers to install more plugins

[customization]

prefixes = .!                     # bot prefixes

useSsh = False                    # use ssh to clone more plugins

desc = A bot made with aBot       # description to display in /help

[plugins]

root = plugins                    # change plugins folder, leave this as is

```



Plugins may add categories or fields to the config file, refer to their instructions for further configuration.



# Contacts

on [my site](https://alemi.dev) or [mail me](mailto:[email protected])