docs: 更新readme
This commit is contained in:
3
.gitignore
vendored
3
.gitignore
vendored
@@ -5,4 +5,5 @@ test.*
|
||||
*.log
|
||||
.vscode/
|
||||
temp/
|
||||
*.css.map
|
||||
*.css.map
|
||||
.idea/
|
||||
321
README.md
321
README.md
@@ -1,312 +1,31 @@
|
||||
> 如果您觉得我们的项目有帮助，请给我们一个星星（Starred）！您的支持对我们非常重要，将激励我们不断改进和提供更好的内容。谢谢！🙏
|
||||
# Yenai-Plugin-safefork
|
||||
|
||||
<img src="resources/img/logo.gif" alt="看板娘" width = "200" align="right">
|
||||
本仓库是[yenai-plugin](https://github.com/yeyang52/yenai-plugin)的一个fork，遵循GPLv3协议。
|
||||
|
||||
<div align="left">
|
||||
本仓库移除了源仓库中一些开发者为了保留最终控制权而加入的后门代码（将4位成员的QQ视为机器人主人）；
|
||||
**但是：** 本仓库不保证已经移除了所有后门代码，建议使用者仍需自行审查代码。
|
||||
|
||||
# Yenai-Plugin
|
||||
注意：使用者应当遵守与源仓库相同使用要求，包括不得用于非法用途、不得在国内平台上宣传本项目等。
|
||||
|
||||
🐑 **_Yenai-Plugin是一个Yunzai-Bot的扩展插件，提供对Bot的一些便捷操作。_**<img src="https://media.giphy.com/media/mGcNjsfWAjY5AEZNw6/giphy.gif" width="50">
|
||||
## 使用方法
|
||||
|
||||
<br><img src="https://count.getloli.com/get/@:yenai-plugin?theme=rule34" /><br>
|
||||
使用方法与源仓库相同，仅需：
|
||||
|
||||
**Github：**
|
||||
将`https://github.com/yeyang52/yenai-plugin` 替换为 `https://github.com/shing-yu/yenai-plugin`
|
||||
|
||||
[](https://github.com/yeyang52/yenai-plugin/actions/workflows/deploy-docs.yml)
|
||||
[](https://vercel.com/yeyang52/yenai-plugin)
|
||||
[](https://app.netlify.com/sites/yenai-plugin/deploys)
|
||||
**Gitee：**
|
||||
将`https://gitee.com/yeyang52/yenai-plugin` 替换为 `https://gitee.com/xingyv1024/yenai-plugin`
|
||||
|
||||
|
||||
|
||||
[](https://github.com/yeyang52/yenai-plugin/blob/master/LICENSE)
|
||||
[](https://gitmoji.dev)
|
||||
[](https://gitee.com/Le-niao/Yunzai-Bot)
|
||||
**星隅的私有Git服务器（IPv6 only）：**
|
||||
将`https://github.com/yeyang52/yenai-plugin` 替换为 `https://git.shingyu.cn:60/shingyu/yenai-plugin`
|
||||
|
||||
|
||||
|
||||
|
||||
## 说明
|
||||
|
||||
[](https://gitee.com/yeyang52/yenai-plugin/stargazers)
|
||||
[](https://gitee.com/yeyang52/yenai-plugin/members)
|
||||
[](https://github.com/yeyang52/yenai-plugin/stargazers)
|
||||
[](https://github.com/yeyang52/yenai-plugin/network)
|
||||
[](https://github.com/yeyang52/yenai-plugin/issues)
|
||||
</div>
|
||||
我们理解源仓库开发者为了防止插件被滥用而加入了使自己能够控制插件的代码，但是我们认为这种做法是不负责任的。
|
||||
或者至少应该在插件的说明文档中明确提醒这一点，而不是在代码中通过各种方式隐藏这一事实。
|
||||
我们认为，如果代码中存在任何一个后门代码，那么将导致用户丧失对整个项目乃至其作者的信任，甚至可能导致用户对整个开源社区的产生质疑；我们认为这种做法得不偿失。
|
||||
我们承诺，如果源仓库开发者采取 移除后门/明确告知用户后门的存在以及遵守使用条件的约定 ，我们将立即存档本仓库。
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://seladb.github.io/StarTrack-js/#/preload?r=yeyang52,yenai-plugin)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 安装教程 💡
|
||||
|
||||
请将Yenai-Plugin放置在Yunzai-Bot的plugins目录下，重启Yunzai-Bot后即可使用。
|
||||
|
||||
1. 推荐使用git进行安装，以方便后续升级。在Yunzai目录打开终端，运行
|
||||
|
||||
- 使用github
|
||||
```sh
|
||||
git clone -b master --depth=1 https://github.com/yeyang52/yenai-plugin.git ./plugins/yenai-plugin
|
||||
```
|
||||
- 使用gitee
|
||||
```sh
|
||||
git clone -b master --depth=1 https://gitee.com/yeyang52/yenai-plugin.git ./plugins/yenai-plugin
|
||||
```
|
||||
|
||||
2. 安装依赖(可选：不安装依赖将无法使用一些功能)
|
||||
|
||||
```sh
|
||||
pnpm install
|
||||
```
|
||||
|
||||
## 功能介绍 📖
|
||||
|
||||
> Yenai-Plugin为您提供以下功能
|
||||
>
|
||||
> Tip：以下只是简单描述功能具体指令请使用 **#椰奶帮助 #椰奶群管帮助 #椰奶设置**查看
|
||||
|
||||
<details>
|
||||
<summary>事件通知</summary>
|
||||
|
||||
- [x] 撤回监听
|
||||
|
||||
- [x] 好友申请
|
||||
|
||||
- [x] 群邀请
|
||||
|
||||
- [x] 好友|群 列表变动
|
||||
|
||||
- [x] 好友|群 消息
|
||||
|
||||
- [x] Bot被禁言
|
||||
|
||||
Tip：具体可使用 **#椰奶设置** 查看
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>助手功能</summary>
|
||||
|
||||
- [x] 发送 群聊|好友 消息
|
||||
|
||||
- [x] 改头像 | 改昵称 | 改状态 | 改昵称 | 改签名 | 改性别
|
||||
|
||||
- [x] 删好友 | 退群
|
||||
|
||||
- [x] 获取 好友|群 列表
|
||||
|
||||
- [x] 增 删 查 说说
|
||||
|
||||
- [x] 开启/关闭戳一戳
|
||||
|
||||
- [x] 增 删 黑/白名单
|
||||
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>事件处理</summary>
|
||||
|
||||
- [x] 同意|拒绝 好友申请
|
||||
|
||||
- [x] 同意|拒绝 群邀请
|
||||
|
||||
- [x] 回复好友消息
|
||||
|
||||
- [x] 查看现有好友申请/群邀请
|
||||
|
||||
- [x] 同意/拒绝全部好友申请/群邀请
|
||||
|
||||
- [x] 查看全部请求
|
||||
|
||||
- [ ] 查看/回添 单向好友
|
||||
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>娱乐功能</summary>
|
||||
|
||||
- [x] 随机唱鸭
|
||||
|
||||
- [x] 赞我（支持陌生人点赞）
|
||||
|
||||
- [x] coser
|
||||
|
||||
- [x] 支付宝到账语音
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Pixiv功能</summary>
|
||||
|
||||
- [x] Pixiv排行榜
|
||||
|
||||
- [x] Tag搜图
|
||||
|
||||
- [x] Pid搜图
|
||||
|
||||
- [x] Uid搜图
|
||||
|
||||
- [x] 查看热门Tag
|
||||
|
||||
- [x] 查看相关作品
|
||||
|
||||
Tip：详情请参考[此教程](https://docs.qq.com/doc/p/108e5d788607d988ac62e1512552c8bd2d870321)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>群管功能</summary>
|
||||
|
||||
- [x] (全体)?禁言|解禁
|
||||
|
||||
- [x] 允许|禁止 匿名
|
||||
|
||||
- [x] 踢@群员
|
||||
|
||||
- [x] 设置|取消 管理
|
||||
|
||||
- [x] 增 删 查 公告
|
||||
|
||||
- [x] 我要自闭
|
||||
|
||||
- [x] 申请头衔
|
||||
|
||||
- [x] 修改头衔
|
||||
|
||||
- [x] 头衔屏蔽词
|
||||
|
||||
- [x] 查看/清理多久没发言的人
|
||||
|
||||
- [x] 查看/清理从未发言的人
|
||||
|
||||
- [x] 查看最近入群情况
|
||||
|
||||
- [x] 获取禁言列表
|
||||
|
||||
- [x] 解除全部禁言
|
||||
|
||||
- [x] 加群申请处理
|
||||
|
||||
- [x] 白名单
|
||||
|
||||
- [ ] 黑名单
|
||||
|
||||
- [x] 哪个叼毛是龙王
|
||||
|
||||
Tip：具体可使用 **#椰奶群管帮助** 查看
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>搜图搜番</summary>
|
||||
|
||||
- [x] [saucenao](https://saucenao.com)
|
||||
- [x] [whatanime](https://trace.moe)
|
||||
- [x] [ascii2d](https://ascii2d.net)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>哔咔功能</summary>
|
||||
|
||||
- [x] 哔咔搜索
|
||||
- [x] 哔咔看本子
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
<details>
|
||||
<summary>图片状态</summary>
|
||||
|
||||
<img src="resources/img/state.jpg" alt="状态" width = "300" />
|
||||
|
||||
状态Pro
|
||||
|
||||
<img src="resources/img/statePro.jpg" alt="状态" width = "300" />
|
||||
|
||||
</details>
|
||||
<br>
|
||||
|
||||
更多信息请移步[文档](https://yenai.trss.me)
|
||||
|
||||
## 特别鸣谢 ❤️
|
||||
|
||||
- [Yunzai-Bot](https://gitee.com/Le-niao/Yunzai-Bot)
|
||||
- [cq-picsearcher-bot](https://github.com/Tsuk1ko/cq-picsearcher-bot)
|
||||
- [nonebot-plugin-picstatus](https://github.com/lgc2333/nonebot-plugin-picstatus)
|
||||
- [HibiAPI](https://github.com/mixmoe/HibiAPI)
|
||||
- [SauceNAO](https://saucenao.com/)
|
||||
- [Ascii2D](https://ascii2d.net/)
|
||||
- [trace.moe](https://trace.moe) ([GitHub](https://github.com/soruly/trace.moe))
|
||||
- [vilipix](https://www.vilipix.com/)
|
||||
- [trss.me](https://trss.me)
|
||||
|
||||
### 贡献者 ✨
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
||||
[](#contributors-)
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||||
感谢这些了不起的人 ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-disable -->
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/TimeRainStarSky"><img src="https://avatars.githubusercontent.com/u/63490117?v=4?s=100" width="100px;" alt="时雨◎星空"/><br /><sub><b>时雨◎星空</b></sub></a><br /><a href="https://github.com/yeyang52/yenai-plugin/commits?author=TimeRainStarSky" title="Code">💻</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Saury-loser"><img src="https://avatars.githubusercontent.com/u/106982493?v=4?s=100" width="100px;" alt="花海里的秋刀鱼"/><br /><sub><b>花海里的秋刀鱼</b></sub></a><br /><a href="https://github.com/yeyang52/yenai-plugin/commits?author=Saury-loser" title="Code">💻</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Georgebillion"><img src="https://avatars.githubusercontent.com/u/40432824?v=4?s=100" width="100px;" alt="Georgebillion"/><br /><sub><b>Georgebillion</b></sub></a><br /><a href="#ideas-Georgebillion" title="Ideas, Planning, & Feedback">🤔</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/xfdown"><img src="https://avatars.githubusercontent.com/u/42599406?v=4?s=100" width="100px;" alt="小飞"/><br /><sub><b>小飞</b></sub></a><br /><a href="#ideas-xfdown" title="Ideas, Planning, & Feedback">🤔</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/liuzj288"><img src="https://avatars.githubusercontent.com/u/13833404?v=4?s=100" width="100px;" alt="liuzj288"/><br /><sub><b>liuzj288</b></sub></a><br /><a href="https://github.com/yeyang52/yenai-plugin/commits?author=liuzj288" title="Code">💻</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/OKKOM2020"><img src="https://avatars.githubusercontent.com/u/88592811?v=4?s=100" width="100px;" alt="OKKOM2020"/><br /><sub><b>OKKOM2020</b></sub></a><br /><a href="https://github.com/yeyang52/yenai-plugin/commits?author=OKKOM2020" title="Documentation">📖</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/kmiit"><img src="https://avatars.githubusercontent.com/u/61952405?v=4?s=100" width="100px;" alt="大可鸭"/><br /><sub><b>大可鸭</b></sub></a><br /><a href="https://github.com/yeyang52/yenai-plugin/commits?author=kmiit" title="Code">💻</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/SmallK111407"><img src="https://avatars.githubusercontent.com/u/108290923?v=4?s=100" width="100px;" alt="曉k"/><br /><sub><b>曉k</b></sub></a><br /><a href="https://github.com/yeyang52/yenai-plugin/commits?author=SmallK111407" title="Code">💻</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/ikechan8370"><img src="https://avatars.githubusercontent.com/u/21212372?v=4?s=100" width="100px;" alt="ikechan8370"/><br /><sub><b>ikechan8370</b></sub></a><br /><a href="https://github.com/yeyang52/yenai-plugin/commits?author=ikechan8370" title="Code">💻</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/fsqhn"><img src="https://avatars.githubusercontent.com/u/13745793?v=4?s=100" width="100px;" alt="fsqhn"/><br /><sub><b>fsqhn</b></sub></a><br /><a href="https://github.com/yeyang52/yenai-plugin/commits?author=fsqhn" title="Code">💻</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Loli-Lain"><img src="https://avatars.githubusercontent.com/u/74231782?v=4?s=100" width="100px;" alt="Lain."/><br /><sub><b>Lain.</b></sub></a><br /><a href="https://github.com/yeyang52/yenai-plugin/commits?author=Loli-Lain" title="Code">💻</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Denfenglai"><img src="https://avatars.githubusercontent.com/u/129082426?v=4?s=100" width="100px;" alt="等风来"/><br /><sub><b>等风来</b></sub></a><br /><a href="https://github.com/yeyang52/yenai-plugin/commits?author=Denfenglai" title="Code">💻</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://fuxuan.org/"><img src="https://avatars.githubusercontent.com/u/59615518?v=4?s=100" width="100px;" alt="Sora"/><br /><sub><b>Sora</b></sub></a><br /><a href="https://github.com/yeyang52/yenai-plugin/commits?author=8852690" title="Code">💻</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/batvbs"><img src="https://avatars.githubusercontent.com/u/60730393?v=4?s=100" width="100px;" alt="batvbs"/><br /><sub><b>batvbs</b></sub></a><br /><a href="https://github.com/yeyang52/yenai-plugin/commits?author=batvbs" title="Code">💻</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/ifeif"><img src="https://avatars.githubusercontent.com/u/36729028?v=4?s=100" width="100px;" alt="ifeif"/><br /><sub><b>ifeif</b></sub></a><br /><a href="https://github.com/yeyang52/yenai-plugin/commits?author=ifeif" title="Code">💻</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||
|
||||
本段遵循 [all-contributors](https://github.com/all-contributors/all-contributors) 规范，欢迎任何形式的贡献！
|
||||
|
||||
## 如何贡献 🤔
|
||||
|
||||
请查看我们的[贡献指南](CONTRIBUTING.md)，了解如何开始贡献
|
||||
|
||||
## 友情链接 😊
|
||||
|
||||
- [Yunzai-Bot插件索引](https://gitee.com/Hikari666/Yunzai-Bot-plugins-index)
|
||||
- [码云镜像库](https://gitee.com/yeyang52/yenai-plugin)
|
||||
- [Miao-Yunzai](https://gitee.com/yoimiya-kokomi/Miao-Yunzai)
|
||||
- [TRSS-Yunzai](https://gitee.com/TimeRainStarSky/Yunzai)
|
||||
|
||||
## 免责声明 ❗
|
||||
|
||||
1. 功能仅限内部交流与小范围使用，请勿将Yunzai-Bot及Yenai-Plugin用于任何以盈利为目的的场景.
|
||||
2. 图片与其他素材均来自于网络，仅供交流学习使用，如有侵权请联系，会立即删除.
|
||||
|
||||
## 联系方式 <img src="https://media.giphy.com/media/VgCDAzcKvsR6OM0uWg/giphy.gif" width="50">
|
||||
|
||||
🐧：746659424
|
||||
|
||||
💬：914247840
|
||||
|
||||
❤️：[打赏](https://yenai.trss.me/donate.html)
|
||||
|
||||
|
||||
|
||||
[](https://gitee.com/yeyang52/yenai-plugin)
|
||||
源仓库后门隐藏方式：
|
||||
在.github/ISSUE_TEMPLATE/中，存在一个没有文件名的序列化文件，其中包含了源开发者的QQ号MD5值；在代码中对其进行了反序列化并用于判断。
|
||||
|
||||
Reference in New Issue
Block a user