# bookdex-plugin

**Repository Path**: dmax0/bookdex-plugin

## Basic Information

- **Project Name**: bookdex-plugin
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-11
- **Last Updated**: 2026-08-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 书籍角色文本图鉴（bookdex-plugin）

已添加webUI，默认端口为14522，可发送 `#书籍图鉴网页` 查看具体网址。

运行 `#xxx更新` 可以对某条数据进行单独更新。

![help](./resources/help-main.jpg)

## 安装方式

在 Yunzai 主目录执行：

```bash
git clone https://github.com/KexinyingLife/bookdex-plugin.git ./plugins/bookdex-plugin
```

依赖安装（推荐，进入插件目录执行，适配所有用户环境）：

```bash
cd plugins/bookdex-plugin
pnpm i
```

---

## 首次使用（必须先全量拉取）

首次下载后先执行：

```text
#统一更新
```

该命令会一次更新：书籍、角色故事、角色语音、剧情文本、地图文本、角色逸闻、月谕圣牌、圣遗物、武器故事、背包。

---

## 自动拉取机制（42天周期）

插件内置了“42天一个周期”的自动更新窗口：

- 每天会检查一次窗口
- 在每个 42 天周期的第 **1~5 天**（不含第 0 天）自动执行统一更新
- 你仍可随时手动执行 `#统一更新`

---

## 使用说明

- 默认返回文本；命令带 `图片` 返回图片
- 建议优先使用文本模式，尽量少用图片模式
- 分类帮助、搜索结果、长文本会优先使用合并消息发送
- 受平台消息长度与合并消息上限影响，超长内容可能拆分发送，极端情况下会改为 `txt` 文件发送
- 受协议端限制与文本体量影响，图片模式在长文本场景下可能耗时较长，也可能出现发送失败或报错
- 只有引用插件自己发出的帮助、搜索、语音列表或结果消息，序号查看才会生效
- 由于米游社当前没有提供邀约任务文本入口，因此插件目前不支持邀约任务文本

---

## 命令总览（已实现）

### 总入口

- `#书角图鉴帮助`
- `#书籍图鉴帮助`
- `#bookdex帮助`

示例：

```text
#书籍图鉴帮助
```

### 更新模块

- `#统一更新`
- `#重置更新`
- `#书籍更新`
- `#角色故事更新`
- `#语音更新`
- `#剧情更新`
- `#地图文本更新`
- `#角色逸闻更新`
- `#月谕圣牌更新`
- `#圣遗物更新`
- `#武器更新`
- `#背包更新`
- `#书籍导入`

支持单条强制更新（每个模块都可）：

- `#书名书籍更新`
- `#角色名故事更新`
- `#角色名语音更新`
- `#任务名剧情更新`
- `#地图名地图文本更新`
- `#角色名角色逸闻更新`
- `#圣牌名月谕圣牌更新`
- `#套装名圣遗物更新`
- `#武器名武器故事更新`
- `#背包名背包更新`

示例：

```text
#统一更新
#重置更新
#书籍导入
```

### 帮助列表模块

- `#书籍帮助`
- `#角色故事帮助`
- `#语音帮助`
- `#剧情帮助`
- `#地图文本帮助`
- `#角色逸闻帮助`
- `#月谕圣牌帮助`
- `#圣遗物帮助`
- `#武器帮助`
- `#背包帮助`

示例：

```text
#书籍帮助
#剧情帮助
```

### 搜索模块

- `#搜索 关键词`
- `#书籍搜索 关键词`
- `#搜书 关键词`
- `#角色故事搜索 关键词`
- `#语音搜索 关键词`
- `#剧情搜索 关键词`
- `#地图文本搜索 关键词`
- `#角色逸闻搜索 关键词`
- `#月谕圣牌搜索 关键词`
- `#圣遗物搜索 关键词`
- `#武器搜索 关键词`
- `#背包搜索 关键词`

示例：

```text
#搜索 深渊
#剧情搜索 盗宝团
#语音搜索 治愈
```

### 书籍模块

- `#书名`
- `#书名图片`

示例：

```text
#温妮莎传奇
#温妮莎传奇图片
```

### 角色故事模块

- `#角色名故事`
- `#角色名故事详情`
- `#角色名故事图片`

示例：

```text
#雷电将军故事
#雷电将军故事详情
#雷电将军故事图片
```

### 语音模块

- `#角色名语音`
- `#角色名语音图片`
- `序号语音`（引用语音帮助、语音搜索结果、语音列表时）

示例：

```text
#雷电将军语音
#雷电将军语音图片
2语音
```

### 剧情 / 扩展文本 / 装备模块

- `#任务名剧情`
- `#任务名剧情图片`
- `#地图名地图文本`
- `#地图名地图文本图片`
- `#角色名角色逸闻`
- `#角色名角色逸闻图片`
- `#圣牌名月谕圣牌`
- `#圣牌名月谕圣牌图片`
- `#套装名圣遗物`
- `#套装名圣遗物图片`
- `#武器名武器故事`
- `#武器名武器故事图片`
- `#背包名背包`
- `#背包名背包图片`

示例：

```text
#正法炬书剧情
#正法炬书剧情图片
#庆云顶的石碑地图文本
#迪卢克角色逸闻
#月谕圣牌·一·魔法师月谕圣牌
#如雷的盛怒圣遗物
#天空之翼武器故事
#「磐键」位置示意图背包
```

### 序号规则

- `序号`：引用帮助或搜索结果时查看文本
- `序号图片`：引用帮助或搜索结果时查看图片
- `序号语音`：仅语音场景可播放语音

示例：

```text
引用帮助消息发 79
引用搜索结果发 3图片
引用语音列表发 2语音
```

---

## 数据来源（米游社观测枢）

本插件数据抓取使用米游社观测枢相关接口：

- 列表入口（selector）  
  `https://act-api-takumi.mihoyo.com/common/blackboard/ys_obc/v1/content/selector`
- 词条详情（entry_page）  
  `https://act-api-takumi-static.mihoyo.com/hoyowiki/genshin/wapi/entry_page`

频道参数：

- `channel_id=68`：书籍
- `channel_id=25`：角色故事 / 角色语音（语音数据来自角色词条内 `role_voice` 模块）
- `channel_id=43`：剧情文本（主要提取词条中的“剧情对话”模块）
- `channel_id=251`：地图文本（主要提取词条中的“交互文本/interactive_dialogue”模块）
- `channel_id=261`：角色逸闻
- `channel_id=249`：月谕圣牌（主要提取 `multi_table` 文本）
- `channel_id=218`：圣遗物
- `channel_id=5`：武器
- `channel_id=13`：背包

---

## 使用样例

```text
#统一更新
#书籍帮助
#温妮莎传奇
#温妮莎传奇图片
#雷电将军故事
#雷电将军故事详情
#雷电将军故事图片
#雷电将军语音
#语音搜索 治愈
#正法炬书剧情
#正法炬书剧情图片
#地图文本帮助
#地图文本搜索 石碑
#庆云顶的石碑地图文本
#角色逸闻帮助
#迪卢克角色逸闻
#月谕圣牌帮助
#月谕圣牌·一·魔法师月谕圣牌
#剧情搜索 盗宝团
#圣遗物帮助
#武器帮助
#搜索 深渊
#角色故事搜索 旅人
#武器搜索 天空之翼
#背包搜索 示意图
```