QQBotHub

琪琪机器人平台 | 日常生活学习工作工具集 | QQ、Telegram、微信、钉钉、浏览器自动化、打卡、QQ频道

Introduce

琪琪机器人平台 | 日常生活学习工作工具集 | QQ、Telegram、微信、钉钉、浏览器自动化、打卡、QQ频道

Web 可视化 - 无需再在 Console 上操作, 轻松上手
插件化架构 - 轻松使用插件扩展
多平台多架构 - win,linux,osx,amd,arm 均可

注意 : 本项目仅供学习使用, 所有第三方插件与本项目无关

通知: 请尽快更新到最新版 (QQBotHub-v1.0.0 +)

功能

Screenshots

QQStatPlugin

Quick Start

部署

PluginCore Admin 用户名 与 PluginCore Admin 密码 为你自己设置的后台登录用户名与密码, 随意设置即可, 自己记住就行

方式1：原生部署（适合小白）

选择 Releases - QQBotHub, 点我下载找到并下载 QQBotHub 相应平台压缩包， windows系统的 vps，下载 windows-64版本的即可，解压里面有exe，运行它即可（无需再安装其它任何运行库），黑窗口中会显示一个url地址，复制到浏览器中打开即可，保持此黑窗口在后台运行，机器人就不会掉线

方式2: 使用 Render 免费一键部署

点击下方按钮一键部署

免费注册, 无需信用卡验证

Free Instance Hours: 750 hours/month

Free Bandwidth: 100 GB/month

Free Build Minutes: 500 min/month

Render 环境变量

环境变量名称	必填	备注
`PLUGINCORE_ADMIN_USERNAME`	√	PluginCore Admin 用户名
`PLUGINCORE_ADMIN_PASSWORD`	√	PluginCore Admin 密码

方式3: 使用 Railway 免费一键部署

点击下方按钮一键部署

免费注册, 无需信用卡验证

Railway 每月有 $5.00 免费额度, 若只跑本项目完全够用 (应该说绰绰有余)

Railway 环境变量

环境变量名称	必填	备注
`PLUGINCORE_ADMIN_USERNAME`	√	PluginCore Admin 用户名
`PLUGINCORE_ADMIN_PASSWORD`	√	PluginCore Admin 密码

注意:

Railway 修改环境变量会触发重新 Deploy

Railway 重新 Deploy 后会删除数据, 你安装的所有插件及数据都将清空。

方式4: 使用 Heroku 免费一键部署

注意：此种方式可能无法QQ登录

点击下方按钮一键部署

免费注册, 无需信用卡验证

Heroku 每月有免费时长 500小时, 若使用信用卡验证, 可提升到免费 1000小时

Heroku 应用一段时间不访问会自动休眠, 因此为了保证存活, 请使用第三方监控保活, 例如: UptimeRobot: 免费网站监控服务

Heroku 环境变量

环境变量名称	必填	备注
`PLUGINCORE_ADMIN_USERNAME`	√	PluginCore Admin 用户名
`PLUGINCORE_ADMIN_PASSWORD`	√	PluginCore Admin 密码

方式4: 使用 Docker

docker run -d -p 5004:80 -e ASPNETCORE_URLS="http://*:80" -e ASPNETCORE_ENVIRONMENT="Production" -e TZ="Asia/Shanghai"  --name qqbothub yiyungent/qqbothub

# 可选, 进入容器 管理, 例如修改 /app/App_Data/PluginCore.Config.json 中的 PluginCore Admin 用户名与密码
docker exec -it qqbothub bash

现在访问: http://localhost:5004/PluginCore/Admin

QQ 登录

部署完成后

⭐⭐⭐⭐ 一定要先登录 PluginCore Admin, 因为 QQ登录页面 与 PluginCore Admin 使用相同权限⭐⭐⭐⭐
访问 401 说明你没有登录 https://your-domain/PluginCore/Admin

访问: https://your-domain/PluginCore/Admin 进入 PluginCore Admin

访问: https://your-domain 进行 QQ机器人登录

若为 短信验证 , 则直接输入收到的验证码, 点击 提交验证 即可

若为 滑动验证 , 则 点击前往验证, 浏览器在 滑动验证 页面按 F12, 再选择 Network, 通过滑动验证后, 复制 ticket 如下 (不要包括双引号), 将 ticket 粘贴到输入框, 点击 提交验证 即可

注意验证不要等待太久, 否则尝试刷新登录页面以重新登录及获取新验证

注意
⭐⭐⭐⭐当 无法登录 时⭐⭐⭐⭐

当 滑动验证 验证通过 后, 等待一会 , 还是 无法进入已登录状态

可下载 Releases - KonataApp - Assets 在本地登录成功后,
获取 BotKeyStore.json 后, 在登录页面使用配置方式登录

大部分人电脑为 Windows 64 位, 点击 KonataApp-win-x64.zip 下载即可, 下载到本地解压, 双击 KonataApp.exe

运行 KonataApp.exe 会自动给出输入提示, 按提示操作即可

运行 KonataApp.exe 无需额外安装 .NET SDK 或 Runtime, 程序已打包

插件管理

访问: https://your-domain/PluginCore/Admin 进入 PluginCore Admin

插件:
下载插件包,

插件包下载见 Release , 直接插件上传下载的 QQHelloWorldPlugin-net6.0.zip 即可

然后直接 上传 -> 安装 -> 文档 -> 设置 -> 启用 -> 文档 即可

更新 QQBotHub

查看最新版 Releases - QQBotHub

若你使用 Railway 一键部署,
只需要修改 Railway 创建的仓库 (例如: QQBotHub) 里的 Dockerfile 文件里的 yiyungent/qqbothub:v0.5.2 , 更新最后的版本号 v0.5.2 到最新版即可

注意:
请更新前导出插件数据, QQStatPlugin 支持下载数据库到本地, 然后下载最新插件包, 解压, 将数据库文件替换为你导出的数据库文件, 然后在有 QQStatPlugin.sqlite 的路径下打包所有文件为 zip, 上传插件即可
插件设置 可以通过保持打开插件设置页面的方式, 重新安装插件后, 再在此页面点击保存

一些更新 docker qqbothub 可能需要用到的命令

cd /www/wwwroot/qqbothub*
# docker-data 位置用于保存当前容器数据
mkdir -p docker-data/App_Data/
mkdir -p docker-data/Plugins/
mkdir -p docker-data/Plugins_wwwroot/
# 保存当前数据
docker cp qqbothub:/app/App_Data/PluginCore.Config.json docker-data/App_Data/PluginCore.Config.json
docker cp qqbothub:/app/App_Data/plugin.config.json docker-data/App_Data/plugin.config.json
docker cp qqbothub:/app/Plugins/ docker-data/
docker cp qqbothub:/app/Plugins_wwwroot/ docker-data/

# 移除当前
docker stop qqbothub
docker rm qqbothub
docker rmi yiyungent/qqbothub

# 获取最新
# 建议不要使用 latest , 而是指定最新的版本号, 有可能你使用的 docker 仓储源还未同步, 而导致 latest 仍为旧版
#docker pull yiyungent/qqbothub:v1.0.0
docker pull yiyungent/qqbothub:latest
docker run -d -p 53213:80 -e ASPNETCORE_URLS="http://*:80" -e ASPNETCORE_ENVIRONMENT="Production" -e TZ="Asia/Shanghai"  --name qqbothub yiyungent/qqbothub

# 这里我将原本备份的数据保存到了这个路径, 进入这个路径, 将备份数据覆盖到 docker 容器中
cd docker-data

docker cp App_Data/PluginCore.Config.json qqbothub:/app/App_Data/PluginCore.Config.json
docker cp App_Data/plugin.config.json qqbothub:/app/App_Data/plugin.config.json
docker cp Plugins/ qqbothub:/app/
docker cp Plugins_wwwroot/ qqbothub:/app/

# 重启容器
docker restart qqbothub

插件开发

注意:
所有纯基于 PluginCore.IPlugins 开发的插件都通用,
下载插件包, 然后 上传 -> 安装 -> 设置 -> 启用 即可

插件开发可参考:

插件开发 | PluginCore

建议参考: ./plugins/QQHelloWorldPlugin

QQBotHub 插件开发包
插件开发包中已包含:

PluginCore.IPlugins.AspNetCore

注意: 如果你不需要 QQBotHub.Sdk 中的一些 Utils , 那么建议直接依赖 PluginCore.IPlugins.AspNetCore , 减少依赖项, 使之称为通用插件

dotnet add package QQBotHub.Sdk

注意:

本项目目前直接使用的 PluginCore 插件框架, 插件采用激发式, 插件工作完成后, 实例会立即销毁, 无法常驻后台

若需要定时任务, 可以使用 ITimeJobPlugin, 可见 PluginCore 的文档

由于 QQBot 本身为常驻, 因此需额外注意 IPluginFinder 的服务的生命周期/范围, 这点和在 ASP.NET Core 的 Controller 中直接使用不同

Donate

QQBotHub is an Apache-2.0 licensed open source project and completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing.

We accept donations through these channels:

爱发电 (￥5.00 起)
面包多 (￥1.00 起)

Author

QQBotHub.Web Apache-2.0
QQBotHub.Sdk Apache-2.0
QQHelloWorldPlugin GPL-3.0
MoLiPlugin GPL-3.0
QQStatPlugin GPL-3.0
BackupPlugin MIT
AutoLoginPlugin GPL-3.0
QQNotePlugin GPL-3.0
ZhiDaoPlugin GPL-3.0
WebMonitorPlugin Apache-2.0
QQChannelPlugin MIT
MoLi4QQChannelPlugin MIT

QQBotHub © yiyun, Released under the GPL-3.0 License.
Authored and maintained by yiyun with help from contributors (list).

GitHub @yiyungent Gitee @yiyungent

chujwu/QQBotHub

QQBotHub

Introduce

功能

Screenshots

QQStatPlugin

Quick Start

部署

方式1：原生部署（适合小白）

方式2: 使用 Render 免费一键部署

Render 环境变量

方式3: 使用 Railway 免费一键部署

Railway 环境变量

方式4: 使用 Heroku 免费一键部署

Heroku 环境变量

方式4: 使用 Docker

QQ 登录

插件管理

更新 QQBotHub

插件开发

相关项目

社区插件

Donate

Author

chujwu/QQBotHub

QQBotHub

Introduce

功能

Screenshots

QQStatPlugin

Quick Start

部署

方式1：原生部署（适合小白）

方式2: 使用 Render 免费 一键部署

Render 环境变量

方式3: 使用 Railway 免费 一键部署

Railway 环境变量

方式4: 使用 Heroku 免费 一键部署

Heroku 环境变量

方式4: 使用 Docker

QQ 登录

插件管理

更新 QQBotHub

插件开发

相关项目

社区插件

Donate

Author

方式2: 使用 Render 免费一键部署

方式3: 使用 Railway 免费一键部署

方式4: 使用 Heroku 免费一键部署