voice-for-dsh 0.0.0-stage → 0.5.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 junarch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,46 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# voice for dsh
+
+给 DeepSeek Harness Web（dsh web）加"输出朗读"：每轮回答结束后，先把回答改写成口语稿（**转写**），
+再交给 TTS 出声（**播报**）；关掉自动播报，每条助手消息上仍可手动点"**朗读**"。
+
+## 功能
+
+- **自动播报开关**：开 = 每轮结束自动"转写 + 播报"；关 = 不自动，只留每条消息上的"朗读"按钮。
+- **三个播报引擎**：系统 TTS（浏览器语音，默认、开箱即用）／豆包（需配置第三方 API，方言与多音色）／
+  本地 Kokoro（本地运行、离线，中英都读，合成在 dsh 进程内）。
+- **提示音**：工作音／完成音／提问音，默认关闭，可上传自定义音；与朗读互不影响。
+- **失败按因提示**：模型未安装／模型加载失败／合成失败／合成超时／服务报错各有自己的文案。
+
+## 安装
+
+需要 DSH 桌面版 `0.2.1-rc.3` 或更高的兼容版本（已在 `0.2.1-rc.5` 验证）。
+
+```powershell
+# 桌面端自带 CLI，版本随桌面端
+$dsh = "$env:LOCALAPPDATA\Programs\DeepSeek Harness\resources\runtime\cli\bin\dsh.cmd"
+
+& $dsh plugin --profile desktop add voice-for-dsh
+```
+
+重启桌面端，设置页里就有"语音播报"。插件依赖（含本地引擎的原生模块）由安装过程自己装，不用先 `npm install`。
+
+从源码安装（开发用，改代码即生效）：
+
+```powershell
+cd packages/voice-for-dsh; npm install; cd ../..     # link: 不会代装依赖
+& $dsh plugin --profile desktop add link:packages/voice-for-dsh
+```
+
+`link:` 的相对路径由 CLI 自己解析，锚定到哪个目录以 CLI 的实际行为为准；
+解析失败（`cannot resolve profile bundle`）时改成绝对路径 `link:<仓库绝对路径>\packages\voice-for-dsh`。
+
+## 配置
+
+配置存在目标 profile 的 `cordis.patch.yml` 里 `voice` 条目的 `config:` 下（设置页可视化编辑，保存即写回该文件）。
+字段含义见[管线与配置 schema](https://github.com/junarch/voice_for_dsh/blob/main/docs/pipeline.md)；
+本地模型的安装与排障见[本地 TTS](https://github.com/junarch/voice_for_dsh/blob/main/docs/local-tts.md)；
+开发循环见[开发手册](https://github.com/junarch/voice_for_dsh/blob/main/docs/development.md)。
+
+## 协议
+
+[MIT](https://github.com/junarch/voice_for_dsh/blob/main/LICENSE)

package/cordis.patch.yml

@@ -0,0 +1,11 @@
+# voice-for-dsh bundle patch: inserts the voice-readout plugin row
+# into the web profile composition. Applied after dsh-base and dsh-web-app,
+# before the user's own cordis.patch.yml.
+- insert:
+    - id: voice
+      name: 'voice-for-dsh'
+      # config may be overridden by the user's profile cordis.patch.yml:
+      #   - id: voice
+      #     config:
+      #       autoSpeak: true
+      #       ...