# kh-plugin

**Repository Path**: yhArcadia/kh-plugin

## Basic Information

- **Project Name**: kh-plugin
- **Description**: 基于Yunzai的群成员昵称、群名片、头衔、权限与头像历史记录存档插件。有效克制群友“改头换面”秽土转生。
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2026-08-11
- **Last Updated**: 2026-09-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!--
 * @Author: 渔火Arcadia  https://github.com/yhArcadia
 * @Date: 2026-08-06 19:58:55
 * @LastEditors: 渔火Arcadia
 * @LastEditTime: 2026-09-15 16:22:43
 * @FilePath: /kh-plugin/README.md
 * @Description: 
 * 
 * Copyright (c) 2026 by 渔火Arcadia 1761869682@qq.com, All Rights Reserved. 
-->
# Kh-Plugin

基于Yunzai的群成员昵称、群名片、头衔、权限与头像历史记录存档插件。**记录群友的每一副嘴脸**（?，有效克制群友“改头换面”秽土转生。

<img decoding="async" src="./resources/img/meme.jpg" width="25%">

</br>



## 🎯 核心功能
**查询群友历史身份**

<img decoding="async" src="./resources/img/history.jpg" width="45%">

</br>

**支持主动推送**（需要配置目标群）

<img decoding="async" src="./resources/img/push.jpg" width="45%">



## ✨ 扩展功能

趣味排行、获取历史头像文件等。详见下方[📋指令列表&说明](./README.md#指令列表说明)。

<details>
<summary>功能演示</summary>
<img decoding="async" src="./resources/img/veteran.jpg" width="45%">
<img decoding="async" src="./resources/img/vest_king.jpg" width="45%">
</details>


## 📦 安装与升级

### 使用[锅巴](https://gitee.com/guoba-yunzai/guoba-plugin)安装

进入锅巴后台，点击`插件管理` -> `未安装` -> 搜索`kh-plugin` -> `查看详情` -> `立即安装`

### 或者手动安装

<details>
<summary>点击展开</summary>

在 **Yunzai 根目录** 下执行：
```
git clone --depth=1 https://github.com/yhArcadia/kh-plugin ./plugins/kh-plugin
```
或
```
git clone --depth=1 https://gitee.com/yhArcadia/kh-plugin ./plugins/kh-plugin
```
根据网络情况选择其一即可。

拉取完毕后，在 **Yunzai 根目录** 执行：
```
pnpm install --filter kh-plugin
```
以安装依赖

</details>



## 📋 指令列表&说明

<details>
<summary>点击展开</summary>

<img decoding="async" src="./resources/img/help.png" width="90%">

</details>



## ⚙️ 插件配置

<details>
<summary>推荐使用锅巴插件进行个性化配置。</summary>
<img decoding="async" src="./resources/img/guoba.jpg" width="100%">
</details>
也可以手动编辑`kh-plugin/config/config.yaml`，请确保格式合法。




## ❓ QA

| Q | A |
| --- | --- |
| 插件名kh代表什么意思？ | kh是 看history 的缩写，即看看历史身份。并没有其他含义。 |
| 为什么我的排行榜人数很少？ | 初次使用排行类命令，建议先在对应群里执行 `#更新群员信息` 来拉取全员信息，否则排行榜只会包含已发言的群员。 |
| 为什么群友改名换头像后明明发言了，但是bot没有推送？ | 需要将对应群加入实时推送列表。可以通过锅巴来配置，或者参考[这个](./config/default_config.yaml#L67)去创建和编辑`kh-plugin/config/config.yaml`。另：实时检测功能本身也存在[个人cd](./config/default_config.yaml#L73)，因此改名后发言未必会立刻被检测到。 |
| 在官Bot无法正常使用？ | 未适配官机。 |
| `#查信息`每个人得到的注册时间都是xx年01月01日。 | 这个精度只能到年，还没找到更好的抓取方法。 |



## 🔗 相关链接

- [Yunzai插件库](https://github.com/yhArcadia/Yunzai-Bot-plugins-index)
- [锅巴插件](https://github.com/guoba-yunzai/guoba-plugin)




## 💬 交流群

<a target="_blank" href="https://qm.qq.com/cgi-bin/qm/qr?k=0yUY_6Icq8Nw9rdRONBJS-rzP1Wkm14V&jump_from=webapi&authKey=8MK6cXSsrSKV+y1W7kqBq/mxhb6TEqu0qrT8XZy5d30jMBqVaub8FX7Z+2Cbhxdg">134086404</a>



## 📄 许可证

- 本项目使用GNU Affero General Public License v3.0 or later (`AGPL-3.0-or-later`)开源协议，详见[LICENSE](./LICENSE)。