dsh-piggy

Readme

<p align="center"><img src="assets/pigs/base/piglet/idle.png" width="128" alt="dsh-piggy 的小猪"></p>

<h1 align="center">dsh-piggy</h1>

<p align="center">一只住在 <a href="https://github.com/deepseek-ai/deepseek-harness">DeepSeek Harness</a> 里，也能独立住在桌面上的猪。</p>

它会长大、上学、打工、旅行、钓鱼、生病，也会跟你搭话。界面采用动森风格的 App 主菜单，全部玩法都能用鼠标完成。番茄钟、钓鱼这类玩法是扩展：可以单独关掉、删除，也能从本仓库在线下载新扩展（盲盒、扭蛋、菜园、矿洞），下载不了时还能从文件导入。

**欢迎一起画猪。** 小猪立绘提供黑色描边和无描边两套透明 PNG，可在「设置 → 小猪画风」切换（画法见[小猪画风](docs/art/pig-style.md)）；如果你有喜欢的猪猪形象，欢迎提交 [Pull Request](https://github.com/CLICGGER-TYPES/dsh-piggy/pulls)，我会认真看并合并合适的作品。也欢迎 Fork 项目，做一只完全符合自己喜好的猪。自定义皮肤可从[制作教程](docs/guides/creating-skins.md)开始。

- **完整养成**：照顾、成长、学习、工作、旅行、收藏和晋升形态；33 种职业都能打 10 分钟短班，15 个旅行地点带回 52 种纪念品
- **经济**：不限制每天玩几次；金币按来源记账，扩展有自己的币（菜币、矿石币、资质凭证），按汇率和金币互换，删扩展时自动换成金币
- **扩展**：在「设置 → 🧩 扩展」里开关、删除、在线下载和更新，数据保留；下载不了时可以「📦 从文件导入」扩展包，官方扩展断网也能装
- **盲盒**（在线扩展）：照明日方舟寻访的规矩——3★～6★ 摆件、常驻和限时卡池轮换 UP、50 抽后六星概率逐抽提升；卡背翻成闪卡，摆件进图鉴，资质凭证放进钱包、在商店换东西
- **扭蛋**（在线扩展）：零食机、杂货机、药箱三台，每天第一次免费，出现有的食物、洗浴、玩具和药，幸运值满 20 必出金色
- **菜园**（在线扩展）：手绘海边菜园，16 种作物、8 块地，按真实时间生长（离线照算）；水壶、收割镰、播种器买了才能一键操作，雇帮工猪替你收菜补种
- **矿洞**（在线扩展）：木牌手账风，20 层往下挖，5 级镐一级级开路，有矿脉、宝箱、化石和电梯；雇小矿工猪替你挖
- **钓鱼**：40 种鱼、4 个钓点、4 把鱼竿，每种鱼游法不同；咬钩后随机是圆盘、竖条拉锯、拉力收线三种玩法之一，也能让猪自己出门钓 30 分钟到 4 小时
- **桌面版**：Windows、Linux 和 macOS 可独立运行；猪和面板各一个窗口，开面板、拖到屏幕边、冒气泡，猪都稳稳待在原地；小猪大小按百分比调，可以设代理
- **角色外观**：完成厨师或宇航员工作解锁职业外观，另有免费内置皮肤，也可导入自己的 PNG 皮肤包（以前做的 SVG 皮肤照样能用）
- **Emoji 可选**：网页版和桌面版都自带整套彩色 emoji 字体，「设置 → Emoji 样式」可以在「内置」和「系统自带」之间切，机器上缺字也不会变方框
- **出问题能查**：「设置 → 日志 → 导出日志」一键导出运行日志（桌面版弹系统「另存为」），里面记着版本、动作、扩展下载和报错
- **会自己过日子**：按时间问候、提醒喝水休息、过节；点不同部位反应不同；闲着会打滚、打盹（换成睡姿，头顶冒 Zzz）、追蝴蝶，桌面版还能出去散步（默认关）；每天写一篇带点黑色幽默的日记
- **一猪多图**：普通小猪饿了、困了、发烧、起红疹、洗澡、上学、听歌、健身、钓鱼时换成对应的图；还没拆的纸盒是「猪递」；生日当天头顶冒蛋糕，点一下开个小派对
- **零 token**：不注册模型工具，不向对话注入宠物状态

<p align="center">
  <img src="docs/screenshots/readme-desktop.png" width="250" alt="桌面版：猪和贴在它上方的面板">
  <img src="docs/screenshots/readme-home.png" width="250" alt="主菜单">
  <img src="docs/screenshots/extension-achievement-badges.png" width="300" alt="扩展成就的十二枚小猪徽章">
</p>
<p align="center">
  <img src="docs/screenshots/c4-dex-dashboard.png" width="250" alt="图鉴">
  <img src="docs/screenshots/c6-skins.png" width="250" alt="换肤">
</p>
<p align="center">
  <img src="docs/screenshots/readme-feedback-pigs.png" width="560" alt="不同状态下的小猪：猪递、饿了、发烧、红疹、洗澡、上学、听歌、健身、钓鱼、生日">
</p>

## 安装

### DSH 插件

```sh
dsh plugin --profile web add dsh-piggy
```

安装后重启 DSH，再刷新页面。

在按 `dsh-plugin-*` 搜索的社区目录中，也可安装 [`dsh-plugin-piggy`](https://www.npmjs.com/package/dsh-plugin-piggy)：`dsh plugin --profile web add dsh-plugin-piggy`。它加载同一个游戏，每个 profile 安装其中一个即可。

如果想直接使用 GitHub 源码，可以克隆本仓库，再执行 `dsh plugin --profile web add /path/to/dsh-piggy`。

### 桌面版

从 [GitHub Releases](https://github.com/CLICGGER-TYPES/dsh-piggy/releases/latest) 下载对应系统的文件（国内的 Windows 用户可以用 [Gitee 发行版](https://gitee.com/clicgger/dsh-piggy/releases)：Gitee 版的检查更新、游戏包和在线扩展都走 Gitee；Gitee 只发 Windows 安装包，Linux 和 macOS 请用 GitHub）：

- Windows：`setup.exe` 安装版或 `portable.exe` 便携版
- Linux：`AppImage`
- macOS：按芯片选择 `arm64.dmg` 或 `x64.dmg`

macOS 包暂未签名，第一次打开请在访达中右键应用并选择“打开”。更多安装与存档说明见[桌面版指南](docs/guides/desktop.md)。

「设置 → 更新」会分别显示游戏版本和桌面外壳版本（有新正式版时设置图标上有红点）。游戏包可在 App 内更新；桌面外壳从 v0.2.0 起，Windows 安装版和 Linux AppImage 可在 App 内下载并重启安装。Windows 便携版、未签名 macOS 版需到发布页手动替换；旧版外壳需先手动升级一次。详见[更新说明](docs/guides/updates.md)。

当前桌面外壳是 **v0.6.4**：猪和面板是两个窗口（面板单独一个窗口贴在猪旁边，开面板、拖动时猪不再跳）；0.6.4 加了代理设置（跟随系统 / 直连 / 自定义 HTTP、SOCKS5），面板开着时猪说的话也不再被面板挡住。游戏 v0.33.0 起需要 0.6.x 的外壳——旧外壳会继续用自带的游戏包，并在「设置 → 更新」里提示先更新桌面程序（Windows 安装版和 Linux AppImage 可在 App 内更新，其余到发布页下载）。窗口摆放、可点区域、桌面样式等仍在游戏包里，这类修复在「更新」里点一下就到。

在线扩展从本仓库的 [`extensions/registry.json`](extensions/registry.json) 读，文件挂在本仓库的 GitHub Release（`ext-<名字>-<版本>`），下载后逐个核对校验值；只会安装我们自己发布的扩展。格式和写法见[扩展删除与在线下载](docs/design/extension-download.md)。

商店和背包中的「装扮」入口暂时隐藏，已有装扮和穿戴记录会保留；后续会重新设计展示方式。

## 开始玩

右键小猪打开主菜单，左键摸摸它，拖动可以换位置。第一次见到纸盒时连续点三下，把猪接回家。

详细玩法、体型、美术图标设置和命令见[玩法指南](docs/guides/gameplay.md)。换肤可直接阅读[玩家换肤教程](docs/guides/skins.md)，制作皮肤从[自定义皮肤制作教程](docs/guides/creating-skins.md)开始。

图鉴里的「成就」记录日常照顾、学习、工作、旅行、收藏与晋升；基础十六枚小猪徽章之外，菜园、矿洞、扭蛋和盲盒各有三枚扩展徽章，安装并更新对应扩展后可积累。规则及试玩方法见[成就设计](docs/design/achievements.md)和[扩展成就](docs/design/extension-achievements.md)。

## 文档

- [文档中心](docs/README.md)
- [玩法与养成规则](docs/guides/gameplay.md)
- [桌面版安装、存档与更新](docs/guides/desktop.md)
- [游戏包与桌面外壳怎样更新](docs/guides/updates.md)
- [扩展：删除与在线下载](docs/design/extension-download.md) · [盲盒](docs/design/blindbox.md) · [经济体系](docs/design/economy.md)
- [日志与导出](docs/design/log-export.md)（设置 → 日志）
- [维护交接文档（接手维护先读）](docs/HANDOFF.md)
- [开发与调试](docs/DEVELOPMENT.md)
- [版本记录](CHANGELOG.md)

## 开发

```sh
npm install --no-save --package-lock=false esbuild@0.28.2 typescript@5.9.3 @types/node@20.19.43
npm run build
npm test
npm run typecheck
```

开发环境、桌面打包、HTTP 接口和目录说明见[开发指南](docs/DEVELOPMENT.md)。

## 贡献者

这个项目有一半是玩家帮忙做出来的，谢谢每一位交出代码、画作和想法的朋友（按首次贡献时间排序）：

| 贡献者 | 贡献 |
|---|---|
| [@1nuoiscute](https://github.com/1nuoiscute) | 猪猪王原型与恶魔猪形态、肥猪体型和胖胖猪动作立绘；十六项成就与小猪徽章系统（[#6](https://github.com/CLICGGER-TYPES/dsh-piggy/pull/6)）；扩展公共进度事件与十二项扩展成就（[#7](https://github.com/CLICGGER-TYPES/dsh-piggy/pull/7)） |
| [@anupamme](https://github.com/anupamme) | 报告桌面版更新依赖的安全问题（[#5](https://github.com/CLICGGER-TYPES/dsh-piggy/pull/5)） |
| [@tetezi](https://github.com/tetezi) | 面板动作时猪窗口置顶、右键不误摸、脏和生病状态的苍蝇/病毒图标、恢复桌面版状态变色与心情优先级调整，附回归测试（[#8](https://github.com/CLICGGER-TYPES/dsh-piggy/pull/8)，随 [#9](https://github.com/CLICGGER-TYPES/dsh-piggy/pull/9) 合入） |

想加玩法、想画猪、想报 bug 都欢迎：到 [Issues](https://github.com/CLICGGER-TYPES/dsh-piggy/issues) 说一声，或直接提 [Pull Request](https://github.com/CLICGGER-TYPES/dsh-piggy/pulls)（Gitee 用户可以在 [Gitee 仓库](https://gitee.com/clicgger/dsh-piggy) 提 Issue）。合并进来的贡献会记在这张表里。

## 致谢与许可

**不同状态的小猪图**（`assets/pigs/feedback/`）的灵感来自 [PigHub](https://pighub.top/) 上的猪猪图片：以那里的猪猪为参考，由 AI（OpenAI 图像生成，codex 操作）重新画成本项目的样子，没有直接复制原图。谢谢 PigHub 和图片作者！如果你是原图作者，觉得侵犯了你的权利或不喜欢这样使用，请[开 issue](https://github.com/CLICGGER-TYPES/dsh-piggy/issues) 告诉我们，我们会删除相关图片。

视觉风格参考 [animal-island-ui](https://github.com/guokaigdg/animal-island-ui)，玩法数值参考资料见 [THIRD-PARTY.md](THIRD-PARTY.md)。项目采用 [MIT License](LICENSE)；小猪立绘改自 [Noto Emoji](https://github.com/googlefonts/noto-emoji) 的 🐖，按 Apache 2.0 发布（见 [THIRD-PARTY.md](THIRD-PARTY.md)）。