介绍
TIP
本文档面向想要使用、编写或贡献 Kazumi 规则的用户。如果希望自行编写规则,你不需要掌握复杂的全栈开发知识,但应先了解 Kazumi 的基本使用方式,并根据规则类型准备 XPath 或 HTTP、JSON 方面的基础知识。
Kazumi 本身不内置任何番剧源或默认规则,而是通过自定义规则接入各个站点。在首次启动的引导流程或 我的 → 规则管理 中,你可以通过以下方式获取和管理规则:
- 浏览规则仓库:从社区维护的 KazumiRules 仓库发现并安装规则。若在中国大陆访问受限,可开启
规则仓库镜像。 - 从剪贴板导入:粘贴单条或多条
kazumi://规则链接、单条 JSON 规则或 JSON 规则数组。 - 从文件导入:读取本地
.json规则文件(支持单条或批量导入)。 - 新建规则:从模板开始手动编写自定义规则。
规则的工作职责
一条 Kazumi 规则负责完成两件事:
- 搜索(Search):根据关键词返回作品列表(提取作品名称和用于下一步请求的来源标识或页面地址)。
- 选集(Chapter):根据选中的作品返回播放线路和剧集页面(或媒体直链)。
视频资源的启发式嗅探属于 Kazumi 的内部实现(见视频嗅探),规则只需要把 Kazumi 带到最终的播放页面。
规则类型与混合配置
在规则编辑器中,可以分别为搜索规则和选集规则独立选择解析类型:
| 规则类型 | 工作方式 | 适用场景 | 开发指南 |
|---|---|---|---|
| XPath 规则 | 请求网页 HTML,通过 XPath 选择器提取搜索结果、播放线路和剧集链接 | 服务端直接返回完整 HTML 的传统网站 | XPath 规则开发、XPath 规则示例 |
| API 规则 | 直接请求 JSON 接口,通过受限 JSONPath 提取作品、线路和剧集信息 | 前后端分离、通过 JSON 接口加载数据的网站 | API 规则开发 |
搜索和选集类型可以自由组合:
- 纯 XPath(XPath 搜索 + XPath 选集):全程解析网页 HTML。
- 纯 API(API 搜索 + API 选集):全程请求 JSON 接口,搜索结果提取出的条目来源(如内部 ID)作为
@source传入选集接口。 - API 搜索 + XPath 选集:部分站点的搜索通过 JSON 接口返回(有时只返回裸 ID,而非完整 URL),但详情页或播放页仍是传统 HTML。此时可在 API 搜索中配置详情页地址模板(使用
@source拼接出完整详情页 URL),再交由 XPath 选集规则解析线路与剧集。 - XPath 搜索 + API 选集:搜索页为传统 HTML,而选集列表通过接口动态加载。
初次开发时,建议先跟随对应教程完成单一类型的完整数据链路,再根据目标站点的实际结构灵活组合。