# Contributing

感谢你愿意改进 `dsh-mc-client`。这是一个 Windows 优先的 DeepSeek Harness 插件，欢迎提交 issue 或 pull request。

## 开发环境

- Windows 10/11
- Node.js 20+（推荐 22/24）
- 可选：PCL2 + Minecraft Java 版（窗口版功能需要）
- 可选：DeepSeek Harness Desktop 或 `dsh` CLI（用于加载插件）

```powershell
git clone https://github.com/DRheEheAMGary/dsh-mc-client.git
cd dsh-mc-client
npm install
node scripts/check.mjs
```

## 本地加载插件

```powershell
dsh plugin --profile <你的 profile> add .
```

插件改动后：小型修改可在插件管理页禁用/启用该插件来重新加载；新增依赖或 `package.json` 结构变化后建议重启 DSH。

## 验证脚本

`dev/` 下的脚本需要本机已安装 Minecraft/PCL2，并且路径与脚本内一致；它们仅用于开发验证，不随 bundle 发布。

```powershell
node dev/test-service.mjs          # 窗口版：状态 + 截图
node dev/test-launch-java.mjs      # 窗口版：启动 Java 版
node dev/test-java-control.mjs     # 窗口版：移动/视角/聊天/截图
node dev/test-headless-service.mjs # 无窗口版：服务端 + 协议机器人完整链路
```

不要提交以下内容：

- `node_modules/`
- `dev/backup-modules.yaml` 等本机环境备份
- `.acl-recovery/`
- Minecraft 世界存档、服务端 jar、日志
- 任何 access token、账号凭据、个人路径配置

## Pull Request

1. 从 `main` 创建分支；
2. 保持改动聚焦，说明复现/验证步骤；
3. 提交前运行 `node scripts/check.mjs`；
4. 如果改动涉及游戏行为，附上工具调用输出或截图；
5. 不要新增未使用的大文件或二进制文件。

## 安全说明

- 无窗口模式会在本机启动 `online-mode=false` 的专用服务端，仅监听 `127.0.0.1`；不要把它暴露到公网。
- 插件会启动 Java 进程并读写本机 Minecraft/PCL2 目录，请在可信环境中使用。
- 不要在 issue/PR 中粘贴 access token、私钥或完整的游戏启动命令（其中可能包含 token）。