fxdyz
This commit is contained in:
@@ -15,7 +15,8 @@
|
||||
|
||||
- 中文触发词覆盖活动、名剑、排行、交易、阵营、角色、奇遇、副本、家园、社区等场景。
|
||||
- 支持纯文本、远程图片、HTML/Jinja2 渲染图片和图文消息链。
|
||||
- 支持 `宏`、`资历` 两类 10 秒两轮交互，超时默认选择第一项。
|
||||
- 支持 `宏`、`资历` 以及帮会、阵营、其他排行榜的 10 秒两轮交互，超时默认选择第一项。
|
||||
- 查询图片统一使用浅色高对比主题，并可在插件配置页调整渲染清晰度、输出格式和 JPEG 质量。
|
||||
- 支持本地 SQLite 避雷记录的增删改查。
|
||||
- 支持按 AstrBot 会话分别开启总开关和具体 JX3API 实时事件订阅。
|
||||
- 复用 `aiohttp.ClientSession`，统一处理 GET、POST、JSON、图片和分页请求。
|
||||
@@ -78,12 +79,15 @@ pip install -r data/plugins/astrbot_plugin_jx3/requirements.txt
|
||||
|
||||
| 配置项 | 类型 | 默认值 | 说明 |
|
||||
| --- | --- | --- | --- |
|
||||
| `prefix.enable` | `bool` | `true` | 是否启用指令前缀检查 |
|
||||
| `prefix.enable` | `bool` | `false` | 是否启用指令前缀检查 |
|
||||
| `prefix.text` | `string` | `剑三` | 指令前缀内容 |
|
||||
| `jx3api_token` | `string` | 空 | JX3API Token |
|
||||
| `jx3api_ticket` | `string` | 空 | 部分名剑和心法接口需要的推栏 Ticket |
|
||||
| `jx3api_wss` | `string` | `wss://socket.nicemoe.cn` | JX3API 事件通道地址 |
|
||||
| `jx3api_wss_token` | `string` | 空 | 事件版令牌；免费事件无需填写 |
|
||||
| `image_render_quality.device_scale_factor` | `string` | `1.3` | 渲染清晰度，可选 `1.0`、`1.3`、`1.8` |
|
||||
| `image_render_quality.format` | `string` | `jpeg` | 图片输出格式，可选 `jpeg`、`png` |
|
||||
| `image_render_quality.jpeg_quality` | `int` | `100` | JPEG 图片质量，范围 `1-100`，PNG 下不生效 |
|
||||
|
||||
会话区服绑定、区服别名和事件订阅均保存在本地 SQLite。修改 WebSocket 地址或事件版令牌后需要重新加载插件。
|
||||
|
||||
@@ -100,7 +104,7 @@ JX3API Token 可从 [JX3API](https://www.jx3api.com/) 获取。推栏 Ticket 通
|
||||
|
||||
## 使用方式
|
||||
|
||||
默认启用前缀，因此推荐发送：
|
||||
如已启用指令前缀，可发送：
|
||||
|
||||
```text
|
||||
剑三 功能
|
||||
@@ -108,7 +112,7 @@ JX3API Token 可从 [JX3API](https://www.jx3api.com/) 获取。推栏 Ticket 通
|
||||
剑三 战绩 梦江南 角色名 33
|
||||
```
|
||||
|
||||
前缀与指令之间的空格可以省略，例如 `剑三日常` 也能触发。关闭前缀检查后可直接发送 `日常`。
|
||||
前缀与指令之间的空格可以省略，例如 `剑三日常` 也能触发。默认关闭前缀检查，可直接发送 `日常`；启用后才要求使用配置的前缀。
|
||||
|
||||
参数规则：
|
||||
|
||||
@@ -161,29 +165,12 @@ JX3API Token 可从 [JX3API](https://www.jx3api.com/) 获取。推栏 Ticket 通
|
||||
| `战绩 服务器 角色 [模式]` | 角色名剑战绩，模式默认 `33`；图片 | Token + Ticket |
|
||||
| `名剑排行 [模式] [数量]` | 名剑大会排行，默认 `33`、50 条；图片 | Token + Ticket |
|
||||
| `名剑统计 [模式]` | 名剑门派统计，模式默认 `33`；图片 | Token + Ticket |
|
||||
| `帮会排行 服务器` | 回复序号选择神兵宝甲或爱心帮会榜单，最多保留前 50 条；图片 | Token |
|
||||
| `阵营排行 服务器` | 回复序号选择赛季、上周或本周阵营榜单，最多保留前 50 条；图片 | Token |
|
||||
| `其他排行 服务器` | 回复序号选择名士、老江湖、名师等其他榜单，最多保留前 50 条；图片 | Token |
|
||||
| `试炼排行 服务器 心法` | 试炼之地排行；图片 | Token |
|
||||
|
||||
以下排行榜指令均使用 `指令 服务器` 格式，输出图片并需要 Token：
|
||||
|
||||
```text
|
||||
名士五十强
|
||||
老江湖五十强
|
||||
兵甲藏家五十强
|
||||
名师五十强
|
||||
阵营英雄五十强
|
||||
薪火相传五十强
|
||||
庐园广记一百强
|
||||
浩气神兵宝甲五十强
|
||||
恶人神兵宝甲五十强
|
||||
浩气爱心帮会五十强
|
||||
恶人爱心帮会五十强
|
||||
赛季恶人五十强
|
||||
赛季浩气五十强
|
||||
上周恶人五十强
|
||||
上周浩气五十强
|
||||
本周恶人五十强
|
||||
本周浩气五十强
|
||||
```
|
||||
三个聚合排行榜指令都会先发送可选榜单菜单；回复对应序号后才查询并渲染结果。已绑定区服的会话可以省略服务器参数。
|
||||
|
||||
### 物价与交易
|
||||
|
||||
@@ -304,7 +291,7 @@ JX3API Token 可从 [JX3API](https://www.jx3api.com/) 获取。推栏 Ticket 通
|
||||
|
||||
### WebUI 插件管理
|
||||
|
||||
AstrBot 插件详情页中的“剑网三插件管理”页面提供四个页签：会话绑定、事件订阅、区服别名和心法别名。页面可以新增、修改或解除任意会话绑定，查看所有会话的事件总开关及订阅编号，为每个标准区服配置多个别名，并维护心法的 JX3BOX 配装 ID、标准名称和最多 5 个别名。管理页通过 AstrBot Plugin Pages 桥接调用插件 Web API，不直接访问 Dashboard 凭据。
|
||||
AstrBot 插件详情页中的“剑网三插件管理”页面提供四个页签：会话绑定、事件订阅、区服别名和心法别名。页面可以新增、修改或解除任意会话绑定，查看所有会话的事件总开关及订阅编号。区服别名页展示完整标准区服目录，标准名称只读，只能行内编辑别名；心法别名页隐藏 JX3BOX 配装 ID，标准心法名称只读，同样只允许行内编辑最多 5 个别名。管理页通过 AstrBot Plugin Pages 桥接调用插件 Web API，不直接访问 Dashboard 凭据。
|
||||
|
||||
## 业务流程
|
||||
|
||||
@@ -400,13 +387,13 @@ flowchart LR
|
||||
`core/message.py` 根据业务结果选择输出方式：
|
||||
|
||||
- `plain_msg()`：纯文本。
|
||||
- `T2I_image_msg()`：向模板注入业务数据和本地图标，再调用 AstrBot HTML 渲染器生成 JPEG。
|
||||
- `T2I_image_msg()`：向模板注入业务数据和本地图标，再调用 AstrBot HTML 渲染器按插件配置生成图片。
|
||||
- `image_msg()`：直接发送远程图片 URL 或图片数据。
|
||||
- `plain_chain()`：发送文本与图片组成的富媒体消息链；结果包含 HTML 正文时，会将其渲染为图片组件追加到消息链。
|
||||
- `handler_plain_image_msg()`：通用两轮会话；首轮函数直接返回 `{"1": "总览", "2": "杂闻"}` 形式的数字键值对（无 `code`、`msg`、`data` 外层），处理器据此生成序号文本；选择后裁剪为只含所选项的新字典交给次轮函数，再由注入的输出器发送结果；超时固定选择第一项。
|
||||
- `zili()`：在指令入口直接调用上述通用两轮会话处理器，并通过标准图片流程输出结果。
|
||||
- `hong()`、`zili()` 及三类聚合排行榜入口：保持统一调用结构接入上述两轮会话处理器，并按各自需要选择图文消息链或标准图片流程输出结果。
|
||||
|
||||
图片默认使用质量 `100`、完整页面截图和普通设备缩放级别。模板可通过 `icons.img`、`icons.sect`、`icons.serendipity` 访问通用、门派/心法和奇遇图标。
|
||||
图片默认使用 JPEG 质量 `100`、完整页面截图和 `1.3` 倍设备像素比。可以在插件配置页的“图片渲染质量”分组切换 JPEG/PNG、调整 JPEG 质量，并选择 `1.0`、`1.3`、`1.8` 设置渲染清晰度。模板可通过 `icons.img`、`icons.sect`、`icons.serendipity` 访问通用、门派/心法和奇遇图标。
|
||||
|
||||
AstrBot 的渲染接口接收完整 HTML 字符串，因此插件不会依赖渲染端读取本地 CSS 文件。`core/template.py` 会异步读取并缓存公共布局、设计变量、基础样式和组件样式，再按需读取页面专属样式及页面片段，组装完成后把单个完整字符串交给渲染器。共享资源只在首次请求时读取一次；标准页面没有同名 CSS 文件也可以正常组合。
|
||||
|
||||
@@ -525,12 +512,16 @@ git diff --check
|
||||
|
||||
## 当前版本状态
|
||||
|
||||
以下内容是对 v3.4.1 当前源码的静态核对结果，部署和二次开发前应注意：
|
||||
以下内容是对 v3.4.2 当前源码的静态核对结果，部署和二次开发前应注意：
|
||||
|
||||
1. 带区服参数的指令在入口层统一进行会话绑定补齐和别名解析；新增此类指令时参数名应继续使用 `server`。
|
||||
2. 资历分布使用固定的“数字序号 → 大类名称”首轮菜单，通用会话裁剪出单项字典后交给 JX3API `/tuilan/achievement` 次轮查询；模板兼容总览与指定 `subclass` 的不同 `data.total` 层级，并直接使用接口角色字段、`pieces`、`seniority` 和 `score/totalScore` 渲染，JX3BOX 不再参与资历查询。
|
||||
3. `APIClient` 当前默认 `ssl_verify=False`，即外部 HTTPS 请求不校验证书。对传输安全有要求的部署应先评估并调整该设置。
|
||||
4. JX3API 服务初始化时会把 Token 和 Ticket 写入 debug 日志。不要公开调试日志，建议二次开发时移除敏感值输出。
|
||||
1. 查询图片使用浅色高对比主题和放大的内容区域；渲染清晰度、JPEG/PNG 格式及 JPEG 质量由 `image_render_quality` 配置组控制，提高清晰度或使用 PNG 会增加图片体积与渲染耗时。
|
||||
2. `帮会排行`、`阵营排行`、`其他排行` 使用固定的“数字序号 → 榜单名称”首轮菜单，次轮查询统一截取接口返回的前 50 条；取得有效选择后会先停止超时计时器，避免渲染期间重复输出。
|
||||
3. 区服别名 WebUI 展示完整标准区服目录并只允许行内编辑别名；心法别名 WebUI 隐藏配装 ID，后端保存接口也只更新已有心法的别名。
|
||||
4. aiocqhttp 图片发送返回 `retcode=1200` 时只记录警告，不再追加“猪脑过载”提示；该回执代表发送结果不确定，仍建议结合平台日志确认实际送达情况。
|
||||
5. 带区服参数的指令在入口层统一进行会话绑定补齐和别名解析；新增此类指令时参数名应继续使用 `server`。
|
||||
6. 资历分布使用固定的“数字序号 → 大类名称”首轮菜单，通用会话裁剪出单项字典后交给 JX3API `/tuilan/achievement` 次轮查询；模板兼容总览与指定 `subclass` 的不同 `data.total` 层级，并直接使用接口角色字段、`pieces`、`seniority` 和 `score/totalScore` 渲染，JX3BOX 不再参与资历查询。
|
||||
7. `APIClient` 当前默认 `ssl_verify=False`，即外部 HTTPS 请求不校验证书。对传输安全有要求的部署应先评估并调整该设置。
|
||||
8. JX3API 服务初始化时会把 Token 和 Ticket 写入 debug 日志。不要公开调试日志，建议二次开发时移除敏感值输出。
|
||||
|
||||
## 注意事项
|
||||
|
||||
|
||||
Reference in New Issue
Block a user