Miao-Yunzai/README.md

125 lines
4.6 KiB
Markdown
Raw Normal View History

2023-03-04 14:30:13 +08:00
# Miao-Yunzai v3
2023-03-04 16:12:48 +08:00
基于乐神版[云崽v3.0](https://gitee.com/le-niao/Yunzai-Bot) 改造
需要同时安装[miao-plugin](https://github.com/yoimiya-kokomi/miao-plugin.git) 且后续的一些底层改造可能会改变数据结构无法直接迁回原版Yunzai请根据自己需求情况慎重安装
2023-05-28 15:25:23 +08:00
使用[icqq](https://github.com/icqqjs/icqq) 登录防止oicq可能出现的低版本问题
---
2023-05-28 15:25:23 +08:00
与原版Yunzai-Bot的差异
2023-03-04 16:12:48 +08:00
2023-05-28 15:25:23 +08:00
**【注意】:** 由于是独立新的仓库,【只建议新部署/部署后迁移】不建议原Bot直接换源强更
2023-03-04 14:30:13 +08:00
2023-05-28 15:25:23 +08:00
* **一些新特性:** Miao-Yunzai会逐步重构增加新特性与功能可能会有功能与形态上的变化。如期望功能更加稳定可使用此仓库[Yunzai-V3](https://gitee.com/yoimiya-kokomi/Yunzai-Bot)
* **移除了签到功能:** 与原Yunzai独立的仓库去除了较为敏感的签到功能以尝试恢复[Github](https://github.com/yoimiya-kokomi/Miao-Yunzai.git)
环境。附加[Gitee](https://gitee.com/yoimiya-kokomi/Miao-Yunzai.git)
* **默认启用喵版的功能:** 【#角色】【#深渊】【#帮助】等功能默认启用喵版,原版的逻辑会屏蔽,以便于后续逐步精简资源
2023-10-16 20:28:55 +08:00
* **一键迁移 TRSS-Yunzai** 若无法登录QQ可尝试 `node trss` 迁移,迁移后可登录其他协议端 [TRSS-Yunzai](https://gitee.com/TimeRainStarSky/Yunzai)
## Miao-Yunzai后续计划
先刨坑,但也许会咕咕咕
* 功能与`miao-plugin`部分功能进行整合或升级
2023-05-28 15:25:23 +08:00
* [√] 角色卡片、抽卡分析等使用`miao-plugin`版本
* `miao-plugin`的帮助、设置、版本信息会升至`Miao-Yunzai`,以支持更多场景
* 一些底层会与`miao-plugin`做更深层的联动,以支持一些高级功能
2023-05-28 15:25:23 +08:00
* [√] 星铁底层支持,原神&星铁多UID支持
* 基于面板信息的uid管理及认证
* ck切换感知等
* 逐步实验一些新的特性
* 更完备的plugin基础能力支持
* 第三方 IM / Bot / WebAPI 对接或适配等
2023-03-04 14:30:13 +08:00
项目仅供学习交流使用,严禁用于任何商业用途和非法行为
2023-03-04 16:12:48 +08:00
2023-03-04 14:30:13 +08:00
## 使用方法
> 环境准备: Windows or LinuxNode.js [版本至少v16以上](http://nodejs.cn/download/) [Redis](https://redis.io/docs/getting-started/installation/ )
2023-03-04 14:30:13 +08:00
1.克隆项目并安装miao-plugin
请根据网络情况选择Github安装或Gitee安装
```
# 使用 Github
git clone --depth=1 https://github.com/yoimiya-kokomi/Miao-Yunzai.git
cd Miao-Yunzai
git clone --depth=1 https://github.com/yoimiya-kokomi/miao-plugin.git ./plugins/miao-plugin/
# 使用Gitee
git clone --depth=1 https://gitee.com/yoimiya-kokomi/Miao-Yunzai.git
cd Miao-Yunzai
git clone --depth=1 https://gitee.com/yoimiya-kokomi/miao-plugin.git ./plugins/miao-plugin/
2023-03-04 14:30:13 +08:00
```
2.安装[pnpm](https://pnpm.io/zh/installation) ,已安装的可以跳过
2023-03-04 14:30:13 +08:00
```
# 使用npmjs.org安装
2023-03-04 14:30:13 +08:00
npm install pnpm -g
# 指定国内源npmmirror.com安装
npm --registry=https://registry.npmmirror.com install pnpm -g
2023-03-04 14:30:13 +08:00
```
2023-03-04 14:30:13 +08:00
3.安装依赖
2023-03-04 14:30:13 +08:00
```
# 直接安装
pnpm install -P
# 如依赖安装缓慢或失败可尝试更换国内npm源后再执行install命令
2023-03-08 02:39:01 +08:00
pnpm config set registry https://registry.npmmirror.com
2023-03-04 14:30:13 +08:00
pnpm install -P
```
2023-03-04 14:30:13 +08:00
4.运行(首次运行按提示输入登录)
2023-03-04 14:30:13 +08:00
```
node app
```
## 常见问题
### puppeteer 相关问题
linux环境其他环境请自行探索
```sh
puppeteer Chromium 启动中...
Error: Failed to launch the browser process!
```
2023-05-28 15:25:23 +08:00
1. 先检查node版本是否大于14 (不大于14请去升级版本)
2023-05-28 15:25:23 +08:00
```sh
node -v
```
2023-05-28 15:25:23 +08:00
2. 如果大于14 则可能是缺失一些库 请安装这些 (点击代码块右上角直接复制,如果报错可以尝试 sudo)
### 依赖库
2023-05-28 15:25:23 +08:00
```sh
yum install pango.x86_64 libXcomposite.x86_64 libXcursor.x86_64 libXdamage.x86_64 libXext.x86_64 libXi.x86_64 libXtst.x86_64 cups-libs.x86_64 libXScrnSaver.x86_64 libXrandr.x86_64 GConf2.x86_64 alsa-lib.x86_64 atk.x86_64 gtk3.x86_64 -y
```
2023-05-28 15:25:23 +08:00
### 乱码字体解决办法centos安装不了请换源
```sh
2023-05-28 15:25:23 +08:00
yum groupinstall fonts -y
```
2023-03-04 14:30:13 +08:00
## 致谢
2023-05-28 15:25:23 +08:00
| Nickname | Contribution |
|:-------------------------------------------------------------:|------------------|
| [Yunzai v3.0](https://gitee.com/le-niao/Yunzai-Bot) | 乐神的Yunzai-Bot V3 |
| [GardenHamster](https://github.com/GardenHamster/GenshinPray) | 模拟抽卡背景素材来源 |
| [西风驿站](https://bbs.mihoyo.com/ys/collection/839181) | 角色攻略图来源 |
| [米游社友人A](https://bbs.mihoyo.com/ys/collection/428421) | 角色突破素材图来源 |
| [icqq](https://github.com/icqqjs/icqq) | ICQQ |