dshgirl-starter

Readme

# dshgirl-starter

> 统一 DSH 鲸鱼娘插件：人设注入 + 桌面桌宠 + 余额挂件 + 记事 / 定时提醒 / 长期记忆 / 右键提问。
> 仓库名：`dshgirl-starter` · 插件名：`dshgirl`

dshgirl-starter 是一个面向 [DeepSeek Harness (DSH)](https://github.com/deepseek-ai/deepseek-harness) 的集成式初始优化插件，将多个独立组件合并为单一插件，并提供共享长期记忆库和低 token 记忆工具。

---

## ✨ 功能特性

- 🐋 鲸鱼娘人设注入（`PERSONA_LOAD`）
- 🖥️ 桌面大肥鱼 / 鲸鱼桌宠
- 💰 右下角余额小飞鱼挂件
- 📝 记事功能
- ⏰ 定时提醒功能
- 🧠 共享长期记忆库
- 💬 右键菜单“提问 DSH”，创建新会话并显示回复
- 🔧 低 token 记忆工具：
  - `dshgirl_recall_memory`
  - `dshgirl_save_memory`

---

## 📸 截图

| 桌宠运行 | 设置面板 |
| --- | --- |
| ![dsh-bigfish-running](docs/images/dsh-bigfish-running.png) | ![dsh-bigfish-settings](docs/images/dsh-bigfish-settings.png) |

---

## 🚀 安装

详细安装步骤见：

```text
安装使用说明.md
```

快速开始：

```bash
# 1. 安装 Node 依赖
npm install

# 2. 准备 Python Helper 环境（推荐，用于新版右键菜单）
py -3 -m venv .build\python-env
.build\python-env\Scripts\pip install -r requirements.txt pyinstaller

# 3. 安装到 DSH profile
npx @deepseek-ai/dsh plugin --profile web install

# 4. 启动
npx @deepseek-ai/dsh web
```

> 如果不想使用 Python Helper，也可以先构建 exe：
>
> ```bash
> powershell -ExecutionPolicy Bypass -File scripts\build-helper.ps1
> ```

---

## 📖 使用说明

### 右键菜单

| 菜单 | 功能 |
| --- | --- |
| `提问 DSH...` | 输入问题并发送，DSH 新建会话处理后回复显示在对话框中 |
| `记事 -> 新建记事` | 创建记事 |
| `记事 -> 查看记事` | 查看长期记忆库中的记事 |
| `定时提醒 -> 新建提醒` | 创建定时提醒 |
| `定时提醒 -> 查看提醒` | 查看提醒列表 |
| `长期记忆 -> 写入记忆` | 手动写入 key/value |
| `长期记忆 -> 搜索记忆` | 按关键词搜索共享记忆 |

### 长期记忆

记忆库文件：

```text
~/.dsh/storages/dshgirl/memory.json
```

所有 DSH 会话和桌宠共享同一个记忆库，实现记忆互通。

DSH 模型可通过工具按需访问：

```text
dshgirl_recall_memory(keyword)
dshgirl_save_memory(key, value)
```

### HTTP API

| 方法 | 路径 | 说明 |
| --- | --- | --- |
| GET/POST | `/plugins/dshgirl/notes` | 查看/新建记事 |
| GET/POST | `/plugins/dshgirl/reminders` | 查看/新建提醒 |
| GET/POST | `/plugins/dshgirl/memories` | 查看/写入长期记忆 |
| POST | `/plugins/dshgirl/memories/recall` | 搜索长期记忆 |
| POST | `/plugins/dshgirl/ask` | 新建 DSH 会话并提问 |

---

## 🧩 项目来源与原创声明

### 集成的开源项目

- [dsh-dafeiyu](https://github.com/QCYTSN/dsh-dafeiyu) — 桌面大肥鱼 / 鲸鱼桌宠
- [DeepSeek-Balance-Whale-Widget](https://github.com/MeteorNOX/DeepSeek-Balance-Whale-Widget) — 右下角余额小飞鱼挂件
- [dsh-routing-suite](https://github.com/yjh051108/dsh-routing-suite) — DSH 路由 / 注入套件

### 原创部分

- 统一插件架构：将多个独立组件合并为单个 `dshgirl` 插件
- 共享长期记忆库：`memory-store` + `~/.dsh/storages/dshgirl/memory.json`
- 低 token 记忆工具：`dshgirl_recall_memory` / `dshgirl_save_memory`
- 记事功能
- 定时提醒功能：`reminder-scheduler`
- 右键菜单“提问 DSH”对话框及 DSH 新会话集成
- 桌宠右键菜单中的记事 / 提醒 / 长期记忆交互
- 相关协议扩展：`ask-service`、`memory-tools`、Helper 协议消息等

---

## 📄 License

- 源代码采用 [MIT License](LICENSE)。
- 桌宠视觉素材的授权说明见 [ASSET_LICENSE.md](ASSET_LICENSE.md)。

> 本项目为非官方粉丝项目，与 DeepSeek 无隶属或背书关系。