PaiGramTeam/miao-plugin
3
0
Fork 0
mirror of https://github.com/yoimiya-kokomi/miao-plugin.git synced 2024-11-16 04:35:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md (#424)

Browse Source
This commit is contained in:
SanqianQVQ 2023-01-31 19:35:41 +08:00 committed by GitHub
parent fef2f6c969
commit 0b14c21b3b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@ -1,36 +1,40 @@
# Miao-Plugin说明
# Miao-Plugin 说明
Miao-Plugin是一个Yunzai-Bot的升级插件，提供包括角色查询等升级功能。
Miao-Plugin 是一个 Yunzai-Bot 的升级插件，提供包括角色查询等升级功能。
具体功能可在安装插件后 通过 #喵喵帮助 进行查看。如需进行设置可通过 #喵喵设置 命令进行管理。
具体功能可在安装插件后 通过 `#喵喵帮助` 进行查看。如需进行设置则可通过 `#喵喵设置` 命令进行管理。
---
# 安装与更新
## 安装与更新
请将miao-plugin放置在Yunzai-Bot的plugins目录下，重启Yunzai-Bot后即可使用。
请将 miao-plugin 放置在 Yunzai-Bot 的 plugins 目录下，重启 Yunzai-Bot 后即可使用。
推荐使用git进行安装，以方便后续升级。在Yunzai根目录夹打开终端，运行
推荐使用 git 进行安装，以方便后续升级。在 Yunzai-Bot 根目录夹打开终端，运行下述指令之一
```
// 使用gitee
git clone https://gitee.com/yoimiya-kokomi/miao-plugin.git ./plugins/miao-plugin/
pnpm add image-size -w
// 使用github
git clone https://github.com/yoimiya-kokomi/miao-plugin.git ./plugins/miao-plugin/
pnpm add image-size -w
```
进行安装。建议使用上述命令进行安装，以便于后续更新。 管理员发送`#喵喵更新`即可自动更新
进行安装。安装完毕后，管理员只需发送 `#喵喵更新` 即可自动更新 miao-plugin。
如果是手工下载的zip压缩包，请将解压后的miao-plugin文件夹（请删除压缩自带的-master后缀）放置在Yunzai目录下的plugins文件夹内。
如果是手工下载的 zip 压缩包，请将解压后的 miao-plugin 文件夹（请删除压缩自带的-master后缀）放置在 Yunzai-Bot 目录下的 plugins 文件夹内。
---
## Yunzai版本与支持
### V3-Yunzai
目前V3-Yunzai已基本重构完毕，具体可参见 [Yunzai-V3](https://github.com/Le-niao/Yunzai-Bot) ，miao-plugin已经支持V3版本Yunzai，可直接使用。
目前 V3-Yunzai 已基本重构完毕，具体可参见 [Yunzai-V3](https://github.com/Le-niao/Yunzai-Bot) ，miao-plugin 已经支持V3版本 Yunzai，可直接使用。
推荐直接使用V3-Yunzai搭配miao-plugin使用。（不能做V2钉子户——喵佬）
推荐直接使用 V3-Yunzai 搭配 miao-plugin 使用。（不能做V2钉子户——喵佬）
[issue#13](https://github.com/yoimiya-kokomi/miao-plugin/issues/74) : 如启动时报 Cannot find package 'image-size'
的错误，直接在yunzai根目录下`pnpm add image-size -w` 或使用cnpm、npm等包管理工具安装image-size库即可
@ -55,30 +59,32 @@ V2-Yunzai在较长一段时间内会维持更新，进行一些Bugfix及更新
---
# 功能说明
## 功能说明
## #雷神面板
### #雷神面板
### #更新面板
使用指令 `#面板帮助` 即可了解如何使用此功能。
`#更新面板` 依赖于面板查询API，面板服务由 http://enka.network/ 提供
#### #更新面板
查询功能经Enka官方授权([issue#63](https://github.com/yoimiya-kokomi/miao-plugin/issues/63#issuecomment-1199348789))，感谢Enka提供的面板查询服务
`#更新面板` 依赖于面板查询API，面板服务由 http://enka.network/ 提供。
如果可以的话，也请在Patreon上支持Enka，或提供闲置的原神账户，具体可在[Enka官网](http://enka.network/) Discord联系
> 查询功能经Enka官方授权([issue#63](https://github.com/yoimiya-kokomi/miao-plugin/issues/63#issuecomment-1199348789))，感谢Enka提供的面板查询服务
>
> 如果可以的话，也请在Patreon上支持Enka，或提供闲置的原神账户，具体可在[Enka官网](http://enka.network/) Discord联系
>
> [issue#63](https://github.com/yoimiya-kokomi/miao-plugin/issues/63#issuecomment-1199734496) :
> 国内网络如Enka服务访问不稳定，可尝试更换 [@MiniGrayGay](https://github.com/MiniGrayGay) 大佬提供的中转服务 复制`config/profile_default.js`
> 为`config/profile.js`，修改其中enkaApi的url配置，配置完成后重启Bot即可生效
>
> * 【链接1】：https://enka.microgg.cn/
> * 【链接2】：https://enka.minigg.cn/
[issue#63](https://github.com/yoimiya-kokomi/miao-plugin/issues/63#issuecomment-1199734496) :
国内网络如Enka服务访问不稳定，可尝试更换 [@MiniGrayGay](https://github.com/MiniGrayGay) 大佬提供的中转服务 复制`config/profile_default.js`
为`config/profile.js`，修改其中enkaApi的url配置，配置完成后重启Bot即可生效
* 【链接1】：https://enka.microgg.cn/
* 【链接2】：https://enka.minigg.cn/
### #雷神伤害
#### #雷神伤害
喵喵面板附带的伤害计算功能由喵喵本地计算。如计算有偏差 #雷神伤害 查看伤害加成信息，如确认伤害计算有误可提供伤害录屏截图及uid进行反馈
### #雷神圣遗物
#### #雷神圣遗物
圣遗物评分为喵喵版评分规则