miao-plugin/README.md

107 lines
4.5 KiB
Markdown
Raw Normal View History

2023-01-31 11:35:41 +00:00
# Miao-Plugin 说明
2022-04-04 05:36:24 +00:00
`miao-plugin`是一个`Yunzai-Bot`的升级插件,提供包括角色面板、角色查询等角色相关功能。
2022-04-22 04:11:38 +00:00
2023-01-31 11:35:41 +00:00
具体功能可在安装插件后 通过 `#喵喵帮助` 进行查看。如需进行设置则可通过 `#喵喵设置` 命令进行管理。
2022-04-22 04:11:38 +00:00
2022-07-30 21:39:03 +00:00
---
2023-01-31 11:35:41 +00:00
## 安装与更新
2022-04-22 04:11:38 +00:00
### 使用Git安装推荐
2023-01-31 11:35:41 +00:00
请将 miao-plugin 放置在 Yunzai-Bot 的 plugins 目录下,重启 Yunzai-Bot 后即可使用。
2022-04-04 05:36:24 +00:00
请使用 git 进行安装,以方便后续升级。在 Yunzai-Bot 根目录夹打开终端,运行下述指令之一
2022-04-04 05:36:24 +00:00
2022-07-30 21:39:03 +00:00
```
// 使用gitee
git clone --depth=1 https://gitee.com/yoimiya-kokomi/miao-plugin.git ./plugins/miao-plugin/
2023-03-07 17:52:11 +00:00
pnpm install -P
2022-04-22 04:11:38 +00:00
2022-07-30 21:39:03 +00:00
// 使用github
git clone --depth=1 https://github.com/yoimiya-kokomi/miao-plugin.git ./plugins/miao-plugin/
2023-03-07 17:52:11 +00:00
pnpm install -P
2022-07-30 21:39:03 +00:00
```
2023-01-31 11:35:41 +00:00
进行安装。安装完毕后,管理员只需发送 `#喵喵更新` 即可自动更新 miao-plugin。
### 手工下载安装(不推荐)
手工下载安装包,解压后将`miao-plugin-master`更名为`miao-plugin`然后放置在Yunzai的plugins目录内
2022-07-30 21:39:03 +00:00
虽然此方式能够使用,但无法使用`#喵喵更新`进行更新,不利于后续升级,故不推荐使用
2022-07-30 21:39:03 +00:00
---
## Yunzai版本与支持
`miao-plugin` 支持V3 / V2 版本的Yunzai-Bot
* [Miao-Yunzai](https://github.com/yoimiya-kokomi/Miao-Yunzai) : 喵版Yunzai [Gitee](https://gitee.com/yoimiya-kokomi/Miao-Yunzai)
/ [Github](https://github.com/yoimiya-kokomi/Miao-Yunzai) 本体不含签到功能功能迭代较多与miao-plugin打通只建议新部署/迁移
* [Yunzai-V3](https://github.com/yoimiya-kokomi/Yunzai-Bot) Yunzai V3 - 喵喵维护版icqq版本与原版Yunza功能基本一致会保持卡池更新功能相对稳定可从原版Yunzai换源直接升级
* [Yunzai-V3](https://gitee.com/Le-niao/Yunzai-Bot) Yunzai V3 - 乐神原版oicq版本可能会遇到登录问题
2022-07-30 21:39:03 +00:00
---
2023-01-31 11:35:41 +00:00
## 功能说明
2022-07-30 21:39:03 +00:00
2023-01-31 11:35:41 +00:00
### #雷神面板
2022-07-30 21:39:03 +00:00
2023-01-31 11:35:41 +00:00
使用指令 `#面板帮助` 即可了解如何使用此功能。
2023-01-31 11:35:41 +00:00
#### #更新面板
2022-07-30 21:39:03 +00:00
2023-01-31 11:35:41 +00:00
`#更新面板` 依赖于面板查询API面板服务由 http://enka.network/ 提供。
2022-07-30 21:39:03 +00:00
2023-01-31 11:35:41 +00:00
> 查询功能经Enka官方授权([issue#63](https://github.com/yoimiya-kokomi/miao-plugin/issues/63#issuecomment-1199348789))感谢Enka提供的面板查询服务
>
2023-01-31 11:35:41 +00:00
> 如果可以的话也请在Patreon上支持Enka或提供闲置的原神账户具体可在[Enka官网](http://enka.network/) Discord联系
>
> [issue#63](https://github.com/yoimiya-kokomi/miao-plugin/issues/63#issuecomment-1199734496)
> 可尝试使用`MiniGG-Api`面板服务 [@MiniGrayGay](https://github.com/MiniGrayGay)<br>
> 发送 `#喵喵设置面板服务332` 修改国服&B服的面板查询由 `MiniGG-Api` 处理
2022-07-30 21:39:03 +00:00
2023-01-31 11:35:41 +00:00
#### #雷神伤害
2022-07-30 21:39:03 +00:00
喵喵面板附带的伤害计算功能由喵喵本地计算。如计算有偏差 #雷神伤害 查看伤害加成信息如确认伤害计算有误可提供伤害录屏截图及uid进行反馈
2023-01-31 11:35:41 +00:00
#### #雷神圣遗物
2022-07-30 21:39:03 +00:00
圣遗物评分为喵喵版评分规则
---
2023-02-03 15:05:12 +00:00
**在有一定阅读理解能力基础下,建议阅读 [CHANGELOG.md](CHANGELOG.md) 以了解更多内容。**
2022-07-30 21:39:03 +00:00
其余文档咕咕咕中
---
2022-04-22 04:11:38 +00:00
# 免责声明
1. `miao-plugin`自身的UI与代码均开放无需征得特殊同意可任意使用。能备注来源最好但不强求
2. 以上声明但仅代表`miao-plugin`自身的范畴请尊重Yunzai本体及其他插件作者的努力勿将Yunzai及其他插件用于以盈利为目的的场景
3. miao-plugin的图片与其他素材均来自于网络仅供交流学习使用如有侵权请联系会立即删除
2022-04-22 04:11:38 +00:00
# 资源
* [Miao-Yunzai](https://github.com/yoimiya-kokomi/Miao-Yunzai) : 喵版Yunzai [Gitee](https://gitee.com/yoimiya-kokomi/Miao-Yunzai)
/ [Github](https://github.com/yoimiya-kokomi/Miao-Yunzai)
* [Yunzai-V3](https://github.com/yoimiya-kokomi/Yunzai-Bot) Yunzai V3 - 喵喵维护版(使用 icqq
* [Yunzai-V3](https://gitee.com/Le-niao/Yunzai-Bot) Yunzai V3 - 乐神原版(使用 oicq
* [miao-plugin](https://github.com/yoimiya-kokomi/miao-plugin) : 喵喵插件 [Gitee](https://gitee.com/yoimiya-kokomi/miao-plugin)
2022-07-30 21:39:03 +00:00
/ [Github](https://github.com/yoimiya-kokomi/miao-plugin)
# 其他&感谢
* [Enka.Network](https://enka.network/): 感谢Enka提供的面板服务
* [Snap.Hutao](https://hut.ao/) : 感谢 DGP Studio 开发的 [胡桃 API](https://github.com/DGP-Studio/Snap.Hutao.Server)
2022-07-30 21:39:03 +00:00
* QQ群暂时停止新加入请见谅
* Yunzai-Bot 官方QQ群213938015
* 喵喵Miao-Plugin QQ群607710456
* [爱发电](https://afdian.net/@kokomi) :欢迎老板打赏,喵~
2022-04-04 05:36:24 +00:00