diff --git a/README.md b/README.md index 562b5db7..65075e5b 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,55 @@ -
+
-![maven](https://img.shields.io/badge/python-3.8%2B-blue) -![maven](https://img.shields.io/badge/nonebot-2.0.0-yellow) -![maven](https://img.shields.io/badge/go--cqhttp-1.0.0-red) +
+ +![maven](https://img.shields.io/badge/python-3.9%2B-blue) +![maven](https://img.shields.io/badge/nonebot-2.1.3-yellow) + +
+ +
# 绪山真寻Bot +
+ **** +
+ “真寻是[椛椛](https://github.com/FloatTech/ZeroBot-Plugin)的好朋友!” +
+ **** -此项目基于 Nonebot2 和 go-cqhttp 开发,以 postgresql 作为数据库的QQ群娱乐机器人 ## 关于 用爱发电,某些功能学习借鉴了大佬们的代码,因为绪山真寻实在太可爱了因此开发了 绪山真寻bot,实现了一些对群友的娱乐功能和实用功能(大概)。 -如果该项目的图片等等侵犯猫豆腐老师权益请联系我删除! +如果该项目的图片等等侵犯猫豆腐老师权益请联系我删除! -是新手!希望有个地方讨论绪山真寻Bot,或者有问题或建议,可以发送issues或加入[ [是真寻酱哒(萌新版)](https://jq.qq.com/?_wv=1027&k=u8PgBkMZ) ] +讨论插件开发,nonebot2开发,或者有 安装使用问题开发建议,可以发送issues或加入[ [真寻酱的技术群](https://jq.qq.com/?_wv=1027&k=u8PgBkMZ) ] (在这里请不要吹水!) + +希望有个地方讨论绪山真寻Bot,渴望吹水聊天,可以加入[ [是真寻酱哒(萌新版)](https://jq.qq.com/?_wv=1027&k=u8PgBkMZ) ] -[//]: # (是老手!讨论插件开发,nonebot2开发,可以加入[ [真寻酱的技术群](https://jq.qq.com/?_wv=1027&k=u8PgBkMZ) ]) ## 声明 此项目仅用于学习交流,请勿用于非法用途 + +
+ # Nonebot2 - + 非常 [ **[NICE](https://github.com/nonebot/nonebot2)** ] 的OneBot框架 +
+ ## 未完成的文档 # [传送门](https://hibikier.github.io/zhenxun_bot/) @@ -50,15 +66,40 @@ ![x](https://raw.githubusercontent.com/HibiKier/zhenxun_bot/main/docs_image/html_help.png) -## Web UI -[zhenxun_bot_webui](https://github.com/HibiKier/zhenxun_bot_webui) +## 这是一份扩展 -## 一键安装脚本 +### 0. 体验一下? + +提供dev版本的测试zhenxun +``` +Url: 43.143.112.57:11451/onebot/v11/ws +AccessToken: PUBLIC_ZHENXUN_TEST +``` + +### 1. Web UI + +项目地址: [Web UI](https://github.com/HibiKier/zhenxun_bot_webui) + +
+后台示例图 + +![x](https://raw.githubusercontent.com/HibiKier/zhenxun_bot/main/docs_image/webui1.png) +![x](https://raw.githubusercontent.com/HibiKier/zhenxun_bot/main/docs_image/webui2.png) +![x](https://raw.githubusercontent.com/HibiKier/zhenxun_bot/main/docs_image/webui3.png) +![x](https://raw.githubusercontent.com/HibiKier/zhenxun_bot/main/docs_image/webui4.png) +![x](https://raw.githubusercontent.com/HibiKier/zhenxun_bot/main/docs_image/webui5.png) +![x](https://raw.githubusercontent.com/HibiKier/zhenxun_bot/main/docs_image/webui6.png) +![x](https://raw.githubusercontent.com/HibiKier/zhenxun_bot/main/docs_image/webui7.png) + +
+ + +### 一键安装脚本(新版未测试) [zhenxun_bot-deploy](https://github.com/AkashiCoin/zhenxun_bot-deploy) -## 提供符合真寻标准的插件仓库 +### 提供符合真寻标准的插件仓库(旧版) [AkashiCoin/nonebot_plugins_zhenxun_bot](https://github.com/AkashiCoin/nonebot_plugins_zhenxun_bot) @@ -67,7 +108,7 @@ * 实现了许多功能,且提供了大量功能管理命令 * 通过Config配置项将所有插件配置统计保存至config.yaml,利于统一用户修改 * 方便增删插件,原生nonebot2 matcher,不需要额外修改,仅仅通过简单的配置属性就可以生成`帮助图片`和`帮助信息` -* 提供了cd,阻塞,每日次数等限制,仅仅通过简单的属性就可以生成一个限制,例如:`__plugin_cd_limit__` +* 提供了cd,阻塞,每日次数等限制,仅仅通过简单的属性就可以生成一个限制,例如:`PluginCdBlock` 等 * **..... 更多详细请通过`传送门`查看文档!** ## 功能列表 @@ -226,10 +267,7 @@ ``` -# 配置gocq - -在 https://github.com/Mrs4s/go-cqhttp 下载Releases最新版本,运行后选择反向代理, - 后将gocq的配置文件config.yml中的universal改为universal: ws://127.0.0.1:8080/onebot/v11/ws +# 使用napcat或拉格朗日 # 获取代码 git clone https://github.com/HibiKier/zhenxun.git @@ -247,6 +285,9 @@ poetry install # 安装依赖 # 开始运行 poetry shell # 进入虚拟环境 python bot.py + +# 运行后会在data目录下生成database.json文件,请根据自身数据库配置修改 +# 其他插件配置在data/config.yaml文件中(需要运行一次) ``` ## 简单配置 @@ -256,15 +297,32 @@ python bot.py SUPERUSERS = [""] # 填写你的QQ -2.在configs/config.py文件中 - * 数据库配置 + PLATFORM_SUPERUSERS = ' + { + "qq": [""], # 在此处填写你的qq + "dodo": [], + "kaiheila": [], + "discord": [] + } +' + +2.在data/database.json文件中修改数据库配置 +{ + "bind": "", + "sql_name": "postgres", + "user": "", # 用户们 + "password": "", # 密码 + "address": "", # 数据库地址ip + "port": "", # 数据库端口 + "database": "" # 数据库名称 +} 3.在configs/config.yaml文件中 # 该文件需要启动一次后生成 * 修改插件配置项 ``` -## 使用Docker +## 使用Docker (新版未测试过) **Docker 单机版(仅真寻Bot)** **点击下方的 GitHub 徽标查看教程** @@ -335,11 +393,15 @@ PS: **ARM平台** 请使用全量版 同时 **如果你的机器 RAM < 1G 可能 ## 更新 -### 2024/1/25 +### 2024/8/11 -* 重构webui +* 更新dev -### 2023/12/28 + + +
diff --git a/docs_image/tt.jpg b/docs_image/tt.jpg new file mode 100644 index 00000000..3f105a90 Binary files /dev/null and b/docs_image/tt.jpg differ diff --git a/docs_image/webui1.png b/docs_image/webui1.png new file mode 100644 index 00000000..2cfa5822 Binary files /dev/null and b/docs_image/webui1.png differ diff --git a/docs_image/webui2.png b/docs_image/webui2.png new file mode 100644 index 00000000..ff884972 Binary files /dev/null and b/docs_image/webui2.png differ diff --git a/docs_image/webui3.png b/docs_image/webui3.png new file mode 100644 index 00000000..f328df2d Binary files /dev/null and b/docs_image/webui3.png differ diff --git a/docs_image/webui4.png b/docs_image/webui4.png new file mode 100644 index 00000000..8bf31231 Binary files /dev/null and b/docs_image/webui4.png differ diff --git a/docs_image/webui5.png b/docs_image/webui5.png new file mode 100644 index 00000000..6b8d350e Binary files /dev/null and b/docs_image/webui5.png differ diff --git a/docs_image/webui6.png b/docs_image/webui6.png new file mode 100644 index 00000000..157ad8a6 Binary files /dev/null and b/docs_image/webui6.png differ diff --git a/docs_image/webui7.png b/docs_image/webui7.png new file mode 100644 index 00000000..ac82ab02 Binary files /dev/null and b/docs_image/webui7.png differ