Misaka0

<div align="center"> <h1>Misaka0</h1> <p>一个高度可扩展、模块化的 Telegram Bot 框架</p>

</div>

特性

• 🧩 模块架构：功能模块化，易于扩展和维护
• 🛡️ 权限管理：超管、群管和普通用户权限控制
• 🔒 群白名单：只有授权的群组可以使用
• 📱 会话管理：模块间会话控制，互不干扰
• 📄 分页显示：标准化的分页导航系统，支持页码跳转
• 🐳 容器支持：轻松部署和维护

项目声明

本项目由 AI 生成，每个文件都经过手动校对

作为维护者，我缺乏专业知识以及开源项目经验

因此，针对本项目的 Issue 或 Pull request 不一定能被处理

⭐ 欢迎按照 MIT 许可证自由复制和修改此项目以供您自己使用

快速开始

配置

在部署前，您必须准备配置文件或环境变量

1. 复制示例配置文件：

   cp config/config.json.example config/config.json
   

2. 编辑配置文件，添加你的 Telegram Bot Token 和超级管理员 ID：

   {
     "token": "YOUR_TELEGRAM_BOT_TOKEN_HERE",
     "admin_ids": [123456789],
     "log_level": "INFO",
     "allowed_groups": {},
     "network": {
       "connect_timeout": 20.0,
       "read_timeout": 20.0,
       "write_timeout": 20.0,
       "poll_interval": 1.0
     }
   }
   

3. 如果使用环境变量配置，需要设置以下变量：

• TELEGRAM_BOT_TOKEN：您的 Telegram Bot Token
• ADMIN_IDS：超级管理员 ID，用逗号分隔

使用 Docker 部署时，应用的优先级为：环境变量 > 配置文件

首次运行时，如果没有提供有效的 Token 和 ID 将无法启动

部署方式

方式 1: 使用 Python 虚拟环境

# 创建虚拟环境
python -m venv venv

# 激活虚拟环境
# Windows
venv\Scripts\activate
# Linux/macOS
source venv/bin/activate

# 安装依赖
pip install -r requirements.txt

# 运行 Bot
python bot.py

方式 2: Docker Compose （推荐）

# 启动容器
# 确保 config/config.json 已正确配置
# 或使用环境变量
# 创建 .env 文件
echo "TELEGRAM_BOT_TOKEN=your_token_here" > .env
echo "ADMIN_IDS=123456789" >> .env

# 启动容器
docker-compose up -d

# 查看日志
docker-compose logs -f

方式 3: Docker

# 构建镜像
docker build -t misaka0 .

# 运行容器（使用已配置的 config）
docker run -d --name telegram-bot -v ./config:/app/config misaka0

# 或者使用环境变量运行
docker run -d --name telegram-bot -e TELEGRAM_BOT_TOKEN=your_token_here -e ADMIN_IDS=123456789 -v ./config:/app/config misaka0

# 或者使用环境变量运行 Docker Hub 镜像
docker run -d --name telegram-bot -e TELEGRAM_BOT_TOKEN=your_token_here -e ADMIN_IDS=123456789 -v ./config:/app/config misakamoe/misaka0

使用方法

基本命令

• /start - 启动机器人
• /help - 显示帮助信息
• /id - 显示用户和聊天 ID
• /modules - 列出所有已加载模块
• /commands - 列出所有可用命令
• /cancel - 取消当前操作

管理员命令

• /stats - 显示机器人统计信息（超级管理员）
• /listgroups - 列出授权的群组（超级管理员）
• /addgroup [群组 ID] - 添加群组到白名单（超级管理员）

开发模块

请参阅 modules/README.md 了解如何开发新模块

项目结构

.
├── bot.py                    # 主入口点
├── config/                   # 配置目录
│   └── config.json           # 主配置
├── core/                     # 核心组件
│   ├── bot_engine.py         # 核心引擎
│   ├── module_manager.py     # 模块管理器
│   ├── command_manager.py    # 命令管理器
│   ├── config_manager.py     # 配置管理器
│   └── event_system.py       # 事件系统
├── modules/                  # 模块目录
│   ├── README.md             # 模块开发文档
│   └── echo.py               # 示例模块
├── utils/                    # 工具函数
│   ├── formatter.py          # 文本格式工具
│   ├── logger.py             # 日志工具
│   ├── pagination.py         # 分页工具
│   ├── session_manager.py    # 会话管理器
│   └── state_manager.py      # 状态管理器
└── data/                     # 数据目录（自动生成）
    ├── sessions/             # 会话数据存储
    └── states/               # 模块状态存储

Star History

<a href="https://www.star-history.com/#Misakamoe/Misaka0&Date"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Misakamoe/Misaka0&type=Date&theme=dark" /> <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Misakamoe/Misaka0&type=Date" /> <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Misakamoe/Misaka0&type=Date" /> </picture> </a>