Skip to content

README_CN.md

Latest commit

 

History

History
189 lines (152 loc) · 4.99 KB

README_CN.md

File metadata and controls

189 lines (152 loc) · 4.99 KB
Raw

Koodo Reader 插件

English

本仓库包含 Koodo Reader 所使用的官方插件，涵盖翻译插件、词典插件以及文字转语音（TTS）插件。

仓库结构

├── code/
│   ├── translation/   # 翻译插件源代码
│   ├── dictionary/    # 词典插件源代码
│   └── voice/         # 语音（TTS）插件源代码
├── plugins/
│   ├── translation/   # 编译后的翻译插件 JSON 文件
│   ├── dictionary/    # 编译后的词典插件 JSON 文件
│   └── voice/         # 编译后的语音（TTS）插件 JSON 文件
├── utils/             # 工具脚本（如 SHA256 哈希生成）
├── index.js           # 入口文件 / 辅助运行时
└── package.json       # Node.js 项目配置文件

插件 JSON 格式

每个插件以 JSON 文件定义，结构如下：

翻译插件：

{
  "identifier": "插件标识符",
  "type": "translation",
  "displayName": "显示名称",
  "icon": "图标名称",
  "version": "1.0.0",
  "autoValue": "auto",
  "config": {},
  "langList": { "en": "English", "...": "..." },
  "scriptSHA256": "<script 字段的 SHA256 哈希>",
  "script": "<压缩后的 JavaScript 函数>"
}

词典插件：

{
  "identifier": "插件标识符",
  "type": "dictionary",
  "displayName": "显示名称",
  "icon": "图标名称",
  "version": "1.0.0",
  "config": {},
  "langList": [
    { "lang": "Chinese", "code": "zh-CN", "nativeLang": "简体中文" }
  ],
  "scriptSHA256": "<script 字段的 SHA256 哈希>",
  "script": "<压缩后的 JavaScript 函数>"
}

语音插件：

{
  "identifier": "插件标识符",
  "type": "voice",
  "displayName": "显示名称",
  "icon": "speaker",
  "version": "1.0.0",
  "config": {},
  "voiceList": [
    {
      "name": "音色 ID",
      "gender": "female | male",
      "locale": "zh-CN",
      "displayName": "音色显示名称",
      "plugin": "插件标识符",
      "config": {}
    }
  ],
  "scriptSHA256": "<script 字段的 SHA256 哈希>",
  "script": "<压缩后的 JavaScript 函数>"
}

脚本 API

翻译脚本

script 字段须暴露 translate 函数：

async function translate(text, from, to, axios, config) {
  // text   - 待翻译文本
  // from   - 源语言代码
  // to     - 目标语言代码
  // axios  - 用于 HTTP 请求的 axios 实例
  // config - 用户配置对象
  return "翻译后的文本"; // 嵌入类插件可返回 URL 字符串
}
window.translate = translate;

词典脚本

script 字段须暴露 getDictText 函数：

async function getDictText(text, from, to, axios, t, config) {
  // text   - 待查询的词语或短语
  // from   - 源语言代码
  // to     - 目标语言代码
  // axios  - 用于 HTTP 请求的 axios 实例
  // t      - 国际化翻译函数（如 t("Learn more")）
  // config - 用户配置对象
  return "<p>HTML 内容</p>"; // 嵌入类插件可返回 URL 字符串
}
window.getDictText = getDictText;

语音脚本

script 字段须暴露 getAudioPath 函数：

const getAudioPath = async (text, speed, dirPath, config) => {
  // text    - 待合成文本
  // speed   - 播放速度
  // dirPath - 音频文件保存目录
  // config  - 用户配置对象
  return "/path/to/audio.wav"; // 生成的音频文件绝对路径
};
global.getAudioPath = getAudioPath;

script 字段还可以选择性地暴露 getTTSVoice 函数，该函数用于动态获取语音列表，仅当插件模板中的 voiceList 字段为空数组（[]）时才会被调用：

const getTTSVoice = async (axios, config) => {
  // axios  - 用于 HTTP 请求的 axios 实例
  // config - 用户配置对象
  return [
    {
      name: "音色 ID",
      gender: "female | male",
      locale: "zh-CN",
      displayName: "音色显示名称",
      config: {},
    },
  ];
};
global.getTTSVoice = getTTSVoice;

工具脚本

utils/getCodeSHA256.js

用于计算插件 JSON 文件中 script 字段的 SHA-256 哈希值，该哈希值存储在 scriptSHA256 字段中，供 Koodo Reader 验证插件完整性。

node utils/getCodeSHA256.js

开发指南

环境要求

  • Node.js >= 16
  • npm

安装依赖

npm install

添加新插件

  1. 在 code/<插件类型>/<插件名>.js 中编写插件源代码。
  2. 在 plugins/<插件类型>/<插件名>.json 中编写插件模板。
  3. 压缩和 escape 插件源代码，推荐使用：Online JavaScript Minifier Tool and Compressor，JSON Escape / Unescape
  4. 将处理后的脚本写入插件模板的 script 字段。
  5. 修改 utils/getCodeSHA256.js 中的文件路径后运行，将输出的哈希值填入 scriptSHA256 字段。

开源许可

本项目基于 AGPL v3 协议开源。