# Yunzai-Plugin-Example

**Repository Path**: cmdsteam/yunzai-plugin-example

## Basic Information

- **Project Name**: Yunzai-Plugin-Example
- **Description**: No description available
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-01-19
- **Last Updated**: 2025-01-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# KaedeharaLu和FichteHerbst的云崽js插件仓库
仓库内js插件除```VeryVeryOld```文件夹内，全部为TRSS插件，其它类型的崽请自行测试
发现bug或有好的建议，欢迎发起issue

# 插件列表
## 发言统计-TRSS
该js为“发言统计”插件的TRSS版本，使用方法和基本和上面一样
不同：增加新的设置，发送```#发言榜帮助```查看更多设置。
```
默认设置：
    榜单人数：20
    是否以转发形式发送：否
```
<details>
<summary>帮助</summary>
<pre><code>
let msg=''
msg+=`**********************************\n`
msg+=`欢迎使用由KaedeharaLu开发的发言榜插件\n`
msg+=`**********************************\n`
msg+=`使用方法:\n`
msg+=`----------\n`
msg+=`所有人:\n`
msg+=`1.每次发言都会记录\n`
msg+=`2.#发言榜 : 查看当前群聊的发言总榜单\n`
msg+=`3.#发言榜月榜 : 查看当前群聊本月的发言榜单\n`
msg+=`4.#发言榜周榜 : 查看当前群聊本周的发言榜单\n`
msg+=`5.#发言榜日榜 : 查看当前群聊本日的发言榜单\n`
msg+=`----------\n`
msg+=`主人可用:\n`
msg+=`1."#清除发言榜单":清除当前群聊的发言记录\n`
msg+=`2."#发言榜设置排行+大于0的数字":设置最后显示的榜单人数\n`
msg+=`3."#发言榜设置转发+0/1":设置是否以转发消息的形式发送，防止刷屏\n`
msg+=`注: 设置时请去除加号`
msg+=`**********************************`
await e.reply(msg)
</code></pre>
</details>

推荐通过```#发言榜设置转发1```开启榜单转发发送，防止榜单太长造成刷屏
**注意：如果从旧版本升级上来，文件结构发生改变，要自行迁移。不迁移则会正常读取旧的记录，导致从头计数（不会删除旧的记录）**
旧版结构：
```
./data/snots
        |-qq号1.json
        |-qq号2.json
        |-qq号3.json
        |-qq号4.json
```

新版结构：
```
./data/snots
        |-qq号1
        |   |-snots.json
        |   |-settings.json
        |-qq号2
            |-snots.json
            |-settings.json
```

其中，新的```snots.json```和旧版本的```qq号.json```内容不一样，```settngs.json```会自动创建，只需要按照结构将snots.json重命名并放入文件夹即可，群内再次有人发言时会自动更新数据结构。
**注意：如果更新了2025年1月3日的版本，那么需要手动更新snots文件，在每一个history的每一项中添加week字段；如果没有更新1.3日版本，那么可以直接使用该最新版本。另外，如遇bug敬请谅解，并提issue**

## 发言统计QY-TRSS
该版本作者：[QingYing@tttfff](https://gitee.com/tttfff)
### 须知
此插件原作者为KaedeharaLu 此版本为二创
#### 使用说明 [所有人]
- 发送 ``` #水群榜``` 可查看发言记录榜单，显示前10名和查询者的发言次数和发言次数占比
#### 使用说明 [主人]
- 发送 ``` #清除水群榜单 ```清除当前群聊的水群记录，并备份至backup_snots_G文件夹
- 发送 ``` #清除水群榜单 <群号> ```清除指定群组的发言榜单，并备份至backup_snots_G文件夹
- 发送 ``` #清除所有水群榜单 ```清除所有群组的发言榜单，并备份至backup_snots_A文件夹
- 发送 ``` #查看所有水群榜单设置 ```查看所有群聊的设置信息
- 发送 ``` #水群榜设置排行+大于0的数字 ```设置最后显示的榜单人数
- 发送 ``` #水群榜设置转发+0/1 ```设置是否以转发消息的形式发送，防止刷屏
### 设置
- 文件存储在``` ./data/snots/qq群号/```下
- 榜单记录文件名称为```snots.json```
- 群聊单独的榜单设置文件名称为```settings.json```
```
默认设置：
    榜单人数：10
    是否以转发形式发送：是
    重置周期：每月
```

## 反馈-TRSS
### 使用
- 发送```#反馈+反馈内容```即可自动记录反馈内容
- 反馈记录文件在```./data/feedback.json```
### 主人操作
- 发送```#查看反馈```则输出记录的反馈内容
- 发送```#清除反馈记录```则删除存在的feedback.json文件
- 以上操作均有检查文件是否存在的操作，一般不会出bug

## 自动更新NapCat
### 须知
- 目前由于NapCat的缺陷，自动重启不可用，再提示“更新完成”后，请手动重启NapCat程序。
- 当前该js插件仅适用于v2.0.0以后的版本，如果为1.x.x版本请先手动更新到v2.0.22（比较稳定）及以后的版本再使用本插件。
- 使用前请添加依赖pnpm add (axios，http-proxy-agent，https-proxy-agent，adm-zip) -w
  `pnpm add axios -w`
  `pnpm add http-proxy-agent -w`
  `pnpm add https-proxy-agent -w`
  `pnpm add adm-zip -w`
  
- 须在34行配置目录，例如：原先的运行目录是`E:\111\NapCat.Shell`，则填入`E:\\111\\NapCat.Shell`
- 目录的最后一级名称一定要为`NapCat.Shell`

### 使用方法
放入plugins/example文件夹中即可
```
介绍一下NapCat吧
NapCat为云崽的适配器，可以通过ws反向连接的方式连接应用端，可以直接扫码登录
由于是直接使用的ntqq的文件，模拟用户操作，封号/冻结的概率低
项目地址：[NapCatQQ](https://github.com/NapNeko/NapCatQQ)
```

## 简单彩票-TRSS

### 免责声明
- 该插件开源，且只是名字叫彩票，其中的词汇如“购买彩票”“卖彩票”均不需要任何货币，即无任何金钱交易，类似于比运气的插件。如果被用于金钱交易等行为，均与本人无关。
- 该插件开源，且只是名字叫彩票，其中的词汇如“购买彩票”“卖彩票”均不需要任何货币，即无任何金钱交易，类似于比运气的插件。如果被用于金钱交易等行为，均与本人无关。
- 该插件开源，且只是名字叫彩票，其中的词汇如“购买彩票”“卖彩票”均不需要任何货币，即无任何金钱交易，类似于比运气的插件。如果被用于金钱交易等行为，均与本人无关。


### 说明
#### 简介
该插件可以用来比一比群友的运气。该插件以记录用户数据，而不是群聊数据，以此实现多群互通，即一个用户在一个群聊“买”了“彩票”，在另一个群也可以查看。

#### 使用教程
0. “彩票”号码均为3位数，且范围在```100-999```
1. ```#购买彩票```
- ```#购买彩票```可以获得一个随机的彩票号码（不会重复），也可以发送```#购买彩票+xxx```（xxx替换成自己喜欢的三位数），如果已经被其他人“购买”会提醒不可“购买”。
- 如果已经“购买”过“彩票”，则会输出已经“购买”的信息。
2. ```#出卖彩票|#出售彩票|#售出彩票|#卖彩票```
- 同指令名字，就是丢掉已经获得的“彩票”
3. ```#彩票开奖```
- 该指令只有云崽主人可以使用，即开奖。会输出“中奖”的人
- 使用后会计入历史文件
- “开奖”后自动开启下一轮
4. ```#彩票历史```
- 即查看过去的记录，会显示参与人数、“中奖”号码等信息
5. ```#我的历史```
- 即查看自己过去参与的历史，会显示购买时间、是否中奖等信息
6. ```#我的彩票```
- 即显示当前已有的“彩票”
```
注意：
1.以上的诸如“彩票”“购买”等字眼打上双引号是为了说明并非真正的说明，不设计赌博、金钱交易
2.关于“彩票”信息输出时，如果不是在当前群聊“购买”的，不会显示群聊信息
3.历史输出时，最多输出20条记录，超出20条的话只显示最后20条
```

### bug
该插件未经严格测试，如有bug，请发起issue

## UAPI-TRSS
- 因为不存在对用户信息的处理，理论上云崽都可以使用，但是本人使用TRSS，其他云崽未测试。
- 发送```#UAPI帮助```查看帮助。
- api来自[TechCat](https://chcat.cn/)旗下的免费api接口[UAPI](https://uapis.cn/)。

### 功能
- ```#天气+城市``` 查询某地天气。
- ```#ping+空格+域名/ip``` 调用api进行ping操作。api服务器地址默认湖北，结果仅作参考。
- ```#ua一言``` 获取UAPI提供的一言。
- ```#热搜``` 查看多平台热搜榜前十。
- ```#随机表情+有兽焉/猫猫/二次元/坤坤/熊猫/外国人``` 获取对应的随机表情。

## KimiAI-TRSS
**该插件在TRSS可用，因为不涉及用户昵称获取，理论上喵崽应该也可以，但未测试**
使用方法发送```#km帮助```查看

### 说明
暂时不清楚是我的问题还是API的问题，连续对话时，有时候会导致回答一个问题时，同时回答上一个问题，如果有懂的大佬希望可以帮我看看然后发起issue，谢谢

**注：以下指令不得键入任何空格，否则可能出错**
### 使用方法:
#kimi+问题 : 向Kimi提问
#设置kimi秘钥+Key(不包括+号) : 设置自己的ApiKey(一定私聊机器人)
#km清空对话 : 清除自己和Kimi的对话记录
#km对话历史 : 查看与Kimi的对话历史

### 预设设置:
#km预设查看/#km预设列表 : 查看存储的预设列表
#km预设删除+数字(不包括+号) : 删除对应编号的预设
#km预设使用+数字(不包括+号) : 使用对应编号的预设
#km预设添加+内容(不包括+号) : 将对应预设内容添加到记录
#km预设清空 : 清空自己的预设历史(自动恢复到默认预设)

### ApiKey
因为KimiAPI的免费用户限制比较大(详情见下图)，所以要使用KimiAPI必须先设置ApiKey。要获取ApiKey请前往https://platform.moonshot.cn/console/api-keys，然后```#设置kimi秘钥+Key(不包括+号) : 设置自己的ApiKey(一定私聊机器人)```<br>
![KimiAPI限速][1]
此图来源[官方API文档][https://platform.moonshot.cn/docs/pricing/limits]

[1]: ./assets/image/KimiAPI限速.png