Skip to content

guoba-yunzai/guoba-plugin

Repository files navigation

Guoba-Plugin

Guoba-PluginYunzai-Bot的扩展插件,主要提供后台管理界面。

管理面板仅支持V3版本的Yunzai;V2版本Yunzai仅支持迁移至V3功能。

具体功能可在安装插件后,通过发送#锅巴帮助来进行查看。

已实现的功能

  • 主人登录
    • #锅巴登录
    • 控制台验证码登录
  • 配置文件管理
  • plugin插件管理
  • 编辑喵喵帮助 @realhuhu
  • V2云崽丝滑迁移至V3(视频教程

TODO代办

安装插件

第 1 步:下载插件

在云崽根目录下打开终端,运行:

  • 使用 Gitee
git clone --depth=1 https://gitee.com/guoba-yunzai/guoba-plugin.git ./plugins/Guoba-Plugin/
  • 使用 Github
git clone --depth=1 https://github.com/guoba-yunzai/guoba-plugin.git ./plugins/Guoba-Plugin/

注:根据你的网络情况选择不同的仓库地址,在国内使用Gitee相对稳定

第 2 步:安装依赖

方式1:采用 pnpm

注:如果你不是通过pnpm安装的云崽,那么请【不要】使用此方式,请看方式2

如果你是使用pnpm安装的云崽,那么只需要在云崽根目录下运行此命令即可:

pnpm install --filter=guoba-plugin

注:请务必直接复制提供的命令,否则可能会导致依赖丢失的情况,若发生需自行重新安装。
--filter=guoba-plugin:只安装guoba-plugin下的依赖,其他依赖不处理,防止丢失。

方式2:采用 npm 或 cnpm

如果是使用npmcnpm等其他依赖安装工具,需要手动安装以下依赖:

npm install express multer body-parser jsonwebtoken

如果以上命令执行失败,可尝试使用cnpm进行安装,只需将开头的npm替换成cnpm即可。

注:cnpm需要单独安装,已安装的可以忽略,安装命令如下:
npm install cnpm -g --registry=https://registry.npmmirror.com

第 3 步:运行插件

依赖安装完毕之后,直接运行即可,默认运行端口号是:50831

可在 config/application.yaml 中修改

启动完成之后,可以在控制台中看到网页地址,复制到浏览器中即可访问。

如果访问不到,请发送#锅巴帮助指令获取帮助。

更新插件

一般会自动更新,如需手动更新,请发送#锅巴更新指令

功能预览

  • 主界面 001

  • 查看插件README 002

  • 基础配置 003

  • 群组配置 004

  • 编辑喵喵帮助 005

免责声明

  1. 功能仅限内部交流与小范围使用,严禁将Guoba-Plugin用于任何商业用途或盈利
  2. 图片与其他素材均来自于网络,仅供交流学习使用,如有侵权请联系,会立即删除

其他

  • 最后求个个star或者爱发电 你的支持是维护本项目的动力~