# kovi-plugin-ciyi
[](https://github.com/araea/kovi-plugin-ciyi)
[](https://crates.io/crates/kovi-plugin-ciyi)
Kovi 的词意（猜词游戏）插件。
通过猜测两字词语，根据相似度提示找出目标词语。
## 游戏规则
1. 目标是猜出系统选择的两字词语
2. 每次猜测后会得到相似度排名和相邻词语的提示
3. 例如：`?好) 企业 (地? #467`
- `#467` 表示相似度排名，数字越小越接近答案
- `?好` 和 `地?` 是相邻词语的提示，`?` 表示隐藏的字
4. 每个群组每天有一个词语，猜对后次日刷新
5. 系统会记录猜对次数，可查看排行榜
## 前置
1. 创建 Kovi 项目
2. 执行 `cargo kovi add ciyi`
3. 在 `src/main.rs` 中添加 `kovi_plugin_ciyi`
## 使用
1. 发送 `词意指令` 查看所有指令
2. 发送 `词意猜测 词语`，如 `词意猜测 企业`，获取提示
3. 根据提示继续猜测，直到找出正确答案
4. 可以开启直接猜测模式，无需输入指令前缀
5. 结合 `词意帮助` 与 `词意规则` 自行探索
## 配置
资源目录 : `data/kovi-plugin-ciyi/*`
> 首次运行时自动生成。
### `config.toml` - 插件配置
```toml
# 群组过滤
[channel]
# 白名单群组，如果非空，则只在这些群组响应。
white = []
# 黑名单群组，在这些群组中插件将不响应。
black = ["123456789"]
# 插件配置
[plugin]
# 只有 @ Bot 时才回复
only_at = false
# 指令前缀 示例：["!", "。"]
prefixes = []
# Bot 响应时 @ 用户
at_user = false
# Bot 响应时引用用户消息
quote_user = true
# 是否开启直接猜测模式（不需要指令，直接发送两字词语即可猜测）
direct_guess = false
# 提示中显示几个历史记录
history_display = 10
# 排行榜显示几个人
rank_display = 10
```
### `command.toml` - 指令配置
```toml
[[command]]
# 功能（勿改）
function = "插件指令列表"
# 指令名（可增删）
commands = ["词意指令", "词意帮助", "词意指令列表", "词意帮助列表"]
[[command]]
function = "查看词意游戏规则"
commands = ["词意规则", "词意玩法"]
[[command]]
function = "猜测两字词语"
commands = ["词意猜测"]
[[command]]
function = "查看当前频道的词意排行榜"
commands = ["词意榜"]
[[command]]
function = "查看所有人的词意排行榜"
commands = ["词意全榜"]
[[command]]
function = "切换猜测模式"
commands = ["切换猜测模式"]
```
## 致谢
- [Kovi](https://kovi.threkork.com/)
- [词影](https://cy.surprising.studio/)
---
_Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or [MIT license](LICENSE-MIT) at your option._
_Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions._