# 🐬 桌面宠物插件（DeepSeek Harness）

一个可爱的桌面宠物插件，运行在 DeepSeek Harness (DSH) 的 Web 界面中。

> English documentation: [README.md](README.md)

## 功能特性

- 🐬 **内置海豚** — 可爱的 SVG 海豚「波波」，有表情动画和自由游动
- ✏️ **自定义名字** — 给你的宠物起任何你喜欢的名字（最多 20 字）
- 🖼️ **自定义图片** — 上传你自己的 PNG/JPG/GIF 图片作为宠物
- 🤖 **AI 生成** — 使用 DSH 配置的 AI 模型生成宠物图片
- ❤️ **心情系统** — 抚摸、喂食，心情会随时间变化
- 💾 **持久化** — 状态跨会话保留（本地存储 + 服务端存储）
- ⌨️ **快捷键** — 按 `P` 抚摸，按 `F` 喂食
- 🖱️ **可拖拽** — 把宠物拖到屏幕任意位置

## 安装

### 通过插件市场安装

如果你已经安装了 `dshmarket`（插件市场）：
1. 打开 **设置 → 插件市场**
2. 搜索 "dolphin-pet-plugin"
3. 点击 **安装**

### 通过命令行安装

```bash
dsh plugin --profile web add dolphin-pet-plugin
```

### 本地开发安装

```bash
# 克隆或复制本插件目录
cd dolphin-pet-plugin

# 安装到 DSH web profile
dsh plugin --profile web add .
```

然后重启 `dsh web` 并刷新页面，宠物就会出现在屏幕右下角。

## 使用说明

| 操作 | 效果 |
|------|------|
| 拖动宠物 | 移动到屏幕任意位置 |
| 点击宠物（不拖动） | 抚摸：冒爱心 + 心情上升 |
| 🫳 摸摸按钮 / `P` 键 | 抚摸宠物 |
| 🐟 喂食按钮 / `F` 键 | 喂宠物吃东西 |
| ⚙️ 设置按钮 | 打开设置面板 |

### 设置面板

点击 ⚙️ 按钮打开设置面板，可以：

- **修改名字** — 给你的宠物起个名字
- **选择宠物形象**：
  - 🐬 海豚波波（默认内置 SVG）
  - 🖼️ 自定义 — 上传自己的图片或用 AI 生成

## 工作原理

插件分为两部分：

1. **Host 端（Node.js）** — 注册 HTTP API 路由，并把客户端脚本注入到每个 `index.html` 中
2. **Client 端（浏览器 JS）** — 渲染宠物、处理交互、提供设置面板

配置优先保存在服务端，localStorage 作为降级方案。

## 开发指南

项目结构：

```
dolphin-pet-plugin/
├── package.json          # 插件清单（包含 dsh.bundle 配置）
├── cordis.patch.yml      # Cordis bundle patch（插件挂载方式）
├── README.md             # 英文文档
├── README.zh.md          # 中文文档
├── lib/
│   ├── index.js          # Host 入口：注册路由 + 注入脚本
│   └── routes.js         # HTTP API 路由
└── client/
    └── client.js         # 客户端：宠物渲染 + 设置面板
```

### API 接口

| 方法 | 路径 | 说明 |
|------|------|------|
| GET | `/plugins/dolphin-pet/client.js` | 提供客户端脚本 |
| GET | `/plugins/dolphin-pet/config` | 获取当前宠物配置 |
| POST | `/plugins/dolphin-pet/config` | 更新宠物配置 |
| POST | `/plugins/dolphin-pet/upload` | 上传自定义宠物图片 |
| POST | `/plugins/dolphin-pet/ai-generate` | AI 生成宠物图片 |

## 发布到应用市场

完整指南见 [PUBLISH.md](PUBLISH.md)。核心两步：

### 第一步：发布到 npm（可选但推荐，走预构建安装通道）

```bash
npm login
npm publish
```

### 第二步：提交到 awesome-dsh-plugin（市场的数据源）

1. Fork [awesome-dsh-plugin](https://github.com/awesome-dsh-plugin/awesome-dsh-plugin) 仓库
2. 新建 `data/plugins/bo961386926__dolphin-pet-plugin.yml`：

```yaml
url: https://github.com/bo961386926/dolphin-pet-plugin
name: bo961386926/dolphin-pet-plugin
category: fun
description:
  en: A desktop pet that swims in the web GUI - rename it, upload your own pet image, or generate one with AI.
  zh: 在网页界面里游来游去的桌面宠物——可以改名字、上传自定义图片，或用 AI 生成形象。
```

3. 执行 `npm ci && node scripts/generate-readme.mjs` 重新生成两个 README 并一起提交
4. 提交 PR（要求：仓库创建满 1 天、提交数 ≥ 10、已加 `dsh-plugin` topic）

合并后 CI 每日刷新数据源，通常一天内出现在应用市场里。

## 许可证

MIT