---

🍩 部署文档 & 🧀 开发文档 & 🤝 贡献

Python>=3.9

该项目并未被放弃，只是目前暂无新功能计划。

本项目作为MQ事件驱动LLM的实验性项目而开发。

如遇问题，请提交Issue。

如果您正在寻找类似项目，请查看：https://github.com/AstrBotDevs/AstrBot

---

它集成了消息队列和快照系统，提供插件机制以及在插件执行前的身份验证功能。

该机器人遵循OpenAI格式规范。请使用gateway或one-api进行独立适配。

演示	视觉与语音	代码解释器

🔨 路线图

程序已迭代至第四代。

• 移除遗留代码
• 删除度量系统
• 删除模型选择系统，统一为OpenAI Schema
• 实现更健壮的插件系统
• 简化项目结构
• 取消Provider系统
• 支持钩子
• 接入TTS
• 增加对gpt-4-turbo和视觉功能的独立支持
• 在插件环境中添加LLM引用支持。（文本提取&&搜索）

📦 特性

• 🍪 全面的插件开发生态，采用经典设计，可通过pip安装无缝集成插件
• 📝 无时间与发送者限制的消息系统，逻辑完全解耦
• 📬 提供URL登录机制，为身份验证开发提供灵活且可扩展的解决方案
• 🍰 允许用户授权插件执行。用户可自行配置插件环境变量
• 📦 支持插件访问文件
• 🍟 多平台支持——通过继承基类即可扩展新平台
• 🍔 插件可在新会话中动态决定自身是否加载，从而避免因插件数量过多而导致性能下降

🍔 登录方式

• URL登录: 使用/login <一个token>$<类似https://provider.com/login的东西>进行登录。程序会将token发送到接口以获取配置信息，如何开发此功能。
• 直接登录: 使用/login https://<api端点>/v1$<api密钥>$<模型>$<工具模型如gpt-3.5-turbo>进行登录。

🧀 插件能做的事更多

贴纸转换	定时功能（内置）

🎬 平台支持

平台	支持	文件系统	备注
Telegram	✅	✅
Discord	✅	✅
Kook	✅	✅	不支持“回复触发”
Slack	✅	✅	不支持“回复触发”
Line	❌
QQ	❌
Wechat	❌
Twitter	❌
Matrix	❌
IRC	❌
...			请创建Issue/PR

📦 快速开始

更多信息请参阅🧀 部署文档。

📦 一键部署

如果您使用的是全新服务器，可以使用以下Shell脚本自动安装本项目。

curl -sSL https://raw.githubusercontent.com/LLMKira/Openaibot/main/deploy.sh | bash

📦 手动安装

# 安装语音依赖
apt install ffmpeg
# 安装RabbitMQ
docker pull rabbitmq:3.10-management
docker run -d -p 5672:5672 -p 15672:15672 \
  -e RABBITMQ_DEFAULT_USER=admin \
  -e RABBITMQ_DEFAULT_PASS=8a8a8a \
  --hostname myRabbit \
  --name rabbitmq \
  rabbitmq:3.10-management
docker ps -l
# 安装项目
git clone https://github.com/LlmKira/Openaibot/
cd Openaibot
pip install pdm
pdm install -G bot
cp .env.exp .env && nano .env
# 测试
pdm run python3 start_sender.py
pdm run python3 start_receiver.py
# 上线
apt install npm
npm install pm2 -g
pm2 start pm2.json

请务必更改默认密码，或关闭开放端口，以防止数据库被扫描和攻击。

🥣 Docker

构建中心：sudoskys/llmbot

请注意，如果您使用 Docker 运行该项目，将会启动 Redis、MongoDB 和 RabbitMQ。但如果您在本地运行，则只需启动 RabbitMQ。

手动 Docker-compose 安装

git clone https://github.com/LlmKira/Openaibot.git
cd Openaibot
cp .env.exp .env&&nano .env
docker-compose -f docker-compose.yml up -d

Docker 配置文件 docker-compose.yml 包含所有数据库。实际上，Redis 和 MongoDB 并不是必需的。您可以自行移除这些数据库，并使用本地文件系统。

使用 docker-compose pull 更新镜像。

使用 docker exec -it llmbot /bin/bash 进入 Docker 中的 Shell，输入 exit 退出。

🍪 斜杠命令

clear - 删除聊天记录
login - 登录机器人
help - 显示文档
chat - 对话
task - 使用功能进行对话
ask - 禁用基于功能的对话
tool - 列出所有功能
auth - 授权某个功能
env - 功能的环境变量
learn - 学习您的指令，/learn reset 可以清空

💻 如何开发插件？

请参考 plugins 目录中的示例插件，以及 🧀 插件开发文档 获取插件开发的相关说明。

钩子

钩子用于控制发送者和接收者之间的 EventMessage。例如，我们内置了 voice_hook 钩子。

您可以通过在 .env 文件中设置 VOICE_REPLY_ME=true 来启用它。

/env VOICE_REPLY_ME=yes
# 必须

/env REECHO_VOICE_KEY=<key in dev.reecho.ai>
# 不必

使用 /env VOICE_REPLY_ME=NONE 可以禁用此环境变量。

请查看 llmkira/extra/voice_hook.py 中的源代码，学习如何编写您自己的钩子。

🧀 赞助

📜 注意事项

本项目名为 OpenAiBot，意为“开放人工智能机器人”，与 OpenAI 并无官方关联。

Openaibot 快速上手指南

Openaibot 是一个基于消息队列事件驱动的 LLM 机器人项目，支持插件机制、多平台接入（Telegram, Discord, Kook, Slack 等）以及 OpenAI 格式 schema。

环境准备

在开始之前，请确保您的服务器满足以下要求：

• 操作系统: Linux (推荐 Ubuntu/Debian)
• Python 版本: >= 3.9
• 前置依赖:
  • ffmpeg (用于语音处理)
  • RabbitMQ (核心消息队列，必须)
  • Git, PDM (包管理), Node.js/npm (可选，用于进程守护)

注意：虽然 Docker 部署方案包含 Redis 和 MongoDB，但在本地手动安装时仅需 RabbitMQ 即可运行。

安装步骤

您可以选择一键自动安装或手动安装。

方案一：一键自动安装（推荐新服务器）

如果您使用的是全新的服务器，可直接运行以下脚本自动完成所有依赖安装和项目部署：

curl -sSL https://raw.githubusercontent.com/LLMKira/Openaibot/main/deploy.sh | bash

方案二：手动安装

1. 安装系统依赖与 RabbitMQ

# 安装语音处理依赖
apt install ffmpeg

# 安装并启动 RabbitMQ
docker pull rabbitmq:3.10-management
docker run -d -p 5672:5672 -p 15672:15672 \
  -e RABBITMQ_DEFAULT_USER=admin \
  -e RABBITMQ_DEFAULT_PASS=8a8a8a \
  --hostname myRabbit \
  --name rabbitmq \
  rabbitmq:3.10-management

2. 克隆项目与安装依赖

git clone https://github.com/LlmKira/Openaibot/
cd Openaibot

# 安装 PDM 包管理器
pip install pdm

# 安装项目依赖
pdm install -G bot

3. 配置环境变量

cp .env.exp .env
nano .env
# 请在编辑器中修改 .env 文件，配置 API Key 和 RabbitMQ 连接信息

4. 测试运行

分别启动发送者和接收者进程进行测试：

pdm run python3 start_sender.py
pdm run python3 start_receiver.py

5. 生产环境部署 (可选)

使用 PM2 进行进程守护：

apt install npm
npm install pm2 -g
pm2 start pm2.json

安全警告：请务必修改默认密码或关闭不必要的端口，防止数据库被扫描攻击。

方案三：Docker Compose 部署

如果您偏好容器化部署：

git clone https://github.com/LlmKira/Openaibot.git
cd Openaibot
cp .env.exp .env && nano .env
docker-compose -f docker-compose.yml up -d

注：此方式会自动启动 Redis, MongoDB 和 RabbitMQ。若需精简，可编辑 docker-compose.yml 移除不需要的数据库服务。

基本使用

安装完成后，您需要在聊天平台（如 Telegram 或 Discord）中与机器人交互。

1. 登录配置

使用 /login 命令配置 API 密钥。支持两种模式：

• 标准模式（直接填入 Endpoint 和 Key）：

  /login https://<api endpoint>/v1$<api key>$<the model>$<tool model such as gpt-3.5-turbo>
  

• URL 令牌模式（通过 URL 获取配置）：

  /login <a token>$<something like https://provider.com/login>
  

2. 常用指令

登录成功后，可使用以下斜杠命令：

命令	功能描述
/chat	开始普通对话
/ask	禁用函数调用的对话模式
/task	启用函数调用的对话模式
/tool	列出所有可用函数/插件
/auth	授权特定函数的执行权限
/env	查看或设置插件环境变量
/clear	清除当前聊天记录
/help	显示帮助文档

3. 插件开发简述

项目支持通过 pip 无缝集成插件。您可以参考 plugins 目录下的示例，或查阅插件开发文档进行二次开发。

如需启用内置的语音回复功能，可在对话框中输入：

/env VOICE_REPLY_ME=yes
/env REECHO_VOICE_KEY=<your_reecho_key>