dsh-plugin-sound-notify

Readme

# DSH Sound Notify

> 中文说明：[README.zh-CN.md](README.zh-CN.md)

## 中文简介

这是一个适用于 [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) 的声音通知插件：任务完成时播放完成提示音，出现选择项、问题确认、计划审核或审批请求时播放提醒音。

### 主要功能

- 在 DSH 设置左侧提供独立的“声音通知”页面
- 支持开启或关闭声音通知
- 支持 0–100% 音量调节，并持久保存设置
- 支持分别试听“任务完成”和“等待选择”两种提示音
- 适配浅色和深色主题

### 快速安装

```powershell
dsh plugin --profile web add github:<owner>/dsh-plugin-sound-notify
```

插件包自带 DSH bundle composition。安装后重启 `dsh web`，刷新当前页面，进入 **设置 → 声音通知**；首次使用时点击任一试听按钮，以允许浏览器播放声音。

完整中文文档请查看：[README.zh-CN.md](README.zh-CN.md)。

---

Sound notifications for [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) when a task finishes or a session starts waiting for user input.

## Features

- Completion chime when an agent transitions from running to idle
- Attention chime for questions, plan review, or approval requests
- Dedicated **Sound notifications** page in DSH settings
- Enable/disable toggle
- 0–100% volume control
- Separate preview buttons for both chimes
- Settings persisted through DSH's settings service
- Light/dark theme-aware UI

## Requirements

- DeepSeek Harness `0.1.0-rc.7` compatible Web profile
- A browser that permits audio after a user gesture

## Install from a local checkout

```powershell
dsh plugin --profile web add D:\path\to\dsh-plugin-sound-notify
```

The package includes its own DSH bundle composition, so no separate `cordis.patch.yml` edit is needed. Restart the existing `dsh web` process, refresh its current URL, open **Settings → Sound notifications**, and click either preview once to allow browser audio.

## Install from GitHub

After replacing `<owner>` with the repository owner:

```powershell
dsh plugin --profile web add github:<owner>/dsh-plugin-sound-notify
```

The package includes its own DSH bundle composition; restart `dsh web` after installation.

## Development

```powershell
npm run build
npm test
```

The project intentionally keeps the browser bundle as plain JavaScript so its DSH client manifest can load without a separate bundler toolchain.

## Privacy

The repository contains no credentials, account names, machine-specific paths, telemetry, or user content. Settings contain only the enabled state and volume percentage.

## License

[MIT](LICENSE)