Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nktkln/universal-bot

A flexible Telegram bot that allows you to easily add new features through plugins. Manage multiple functionalities in a single bot without the need to store and maintain several bots.
https://github.com/nktkln/universal-bot

aiogram3 python3

Last synced: 18 days ago
JSON representation

A flexible Telegram bot that allows you to easily add new features through plugins. Manage multiple functionalities in a single bot without the need to store and maintain several bots.

Awesome Lists containing this project

README

        

# ♾️ Universal Bot

## πŸ—’ Description

This bot was created with the goal of simplifying the development and usage of Telegram bots. It allows you to easily add new features through plugins, integrating them into a single main bot. This eliminates the need to store and manage multiple bots with different functionalities in your Telegram account.

## πŸ’Ύ Prerequisites

* [Python](https://www.python.org/)
* [Docker CE](https://docs.docker.com/engine/install/)
* [Docker Compose](https://docs.docker.com/compose/install/)

## βš™οΈ Bot Configuration

Before starting, make sure to edit the `.env` file with your own configuration.

Example:

```env
# Telegram Bot Settings
BOT_TOKEN="110201544:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw"
OWNER_ID=1234567890

# Database settings
DATABASE_URL="sqlite+aiosqlite:///db/database.db"
```

You can get your bot token by contacting [@BotFather](https://t.me/BotFather) on Telegram.

## πŸ“ Plugin Documentation

If you want to create your own plugins, you can find the documentation for writing plugins in the following file: [custom plugin documentation](https://github.com/NKTKLN/Universal-bot/blob/master/bot/custom_plugins/README.md).

## 🐳 Run in Docker

```bash
docker compose up --build -d
```

## πŸ“ ToDo

- [ ] Add the ability to store plugin data in the database
- [ ] Add the ability to update the bot in the settings

## πŸ“ƒ License

All my apps are released under the MIT license, see [LICENSE.md](https://github.com/NKTKLN/Universal-bot/blob/master/LICENSE) for full text.