From f00c70914766710ec9349c30febf6554e3a04dbb Mon Sep 17 00:00:00 2001 From: Kokomi <102026640+yoimiya-kokomi@users.noreply.github.com> Date: Sun, 5 Mar 2023 06:42:24 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0README=EF=BC=8C=E8=A1=A5?= =?UTF-8?q?=E5=85=85=E6=8F=90=E9=86=92=E5=8F=8A=E6=9C=AA=E6=9D=A5=E8=A7=84?= =?UTF-8?q?=E5=88=92?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 37 ++++++++++++++++++++++++++++++++----- 1 file changed, 32 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 36a7279..aae9ec8 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,64 @@ # Miao-Yunzai v3 -基于乐神版[云崽v3.0](https://gitee.com/le-niao/Yunzai-Bot) 改造 -在原版的基础上使用icqq登录,去除了较为敏感的签到等功能 -【尚未完全稳定,暂不建议使用】 +基于乐神版[云崽v3.0](https://gitee.com/le-niao/Yunzai-Bot) 改造,**【尚未完全稳定,暂不建议使用】** +与原Yunzai独立的仓库,去除了较为敏感的签到功能,以尝试恢复[Github](https://github.com/yoimiya-kokomi/Miao-Yunzai.git) +环境。附加[Gitee](https://gitee.com/yoimiya-kokomi/Miao-Yunzai.git) + +* 由于是独立新的仓库,只建议新部署/迁移,不建议原Bot直接换源 +* 使用icqq登录,防止oicq可能出现的低版本问题(如只需要此特性,可使用[Yunzai-V3](https://gitee.com/yoimiya-kokomi/Yunzai-Bot) ) +* 基础功能会保持与Yunzai同步迭代更新,如只需原版Yunzai无需切换 + +## Miao-Yunzai后续计划 + +先刨坑,但也许会咕咕咕 + +* 默认集成`miao-plugin`,部分功能进行整合或升级 + * 角色卡片、抽卡分析等使用`miao-plugin`版本 + * `miao-plugin`的帮助、设置、版本信息会升至`Miao-Yunzai`,以支持更多场景 +* 一些底层会与`miao-plugin`做更深层的联动,以支持一些高级功能 + * 基于面板信息的uid管理及认证 + * ck切换感知等 +* 逐步实验一些新的特性 + * 更完备的plugin基础能力支持 + * 第三方 IM / Bot / WebAPI 对接或适配等 项目仅供学习交流使用,严禁用于任何商业用途和非法行为 - ## 使用方法 ->环境准备: Windows or Linux,Node.js([版本至少v16以上](http://nodejs.cn/download/)),[Redis](https://redis.io/docs/getting-started/installation/) + +> 环境准备: Windows or Linux,Node.js([版本至少v16以上](http://nodejs.cn/download/)),[Redis](https://redis.io/docs/getting-started/installation/) 1.克隆项目 + ``` git clone --depth=1 -b main https://github.com/Le-niao/Yunzai-Bot.git ``` + ``` cd Yunzai-Bot #进入Yunzai目录 ``` + 2.安装[pnpm](https://pnpm.io/zh/installation),已安装的可以跳过 + ``` npm install pnpm -g ``` + 3.安装依赖 + ``` pnpm install -P ``` + 4.运行(首次运行按提示输入登录) + ``` node app ``` ## 致谢 + | Nickname | Contribution | |:-------------------------------------------------------------:|-------------------| | [Yunzai v3.0](https://gitee.com/le-niao/Yunzai-Bot) | 乐神的Yunzai-Bot V3 |