best_annotator/README.md

# DDJ 最佳结果标注

一个局域网内使用的小工具，递归读取 `SKING_DDJ_Dataset` 的 source 与同目录、同编号的多个 result。所有模型统一使用 `模型名/ID前3字符/` 分目录，也兼容旧的平铺和单字符目录。前端使用 React + Vite；`static/` 包含生产构建和本地 3D 依赖，运行只需 Python 3.10+ 标准库，无需 CDN 或 Node。修改前端源码时需要 Node.js 22+。

```bash
python3 app.py --root /home/ds/llms/SKING_DDJ_Dataset --host 192.168.0.111 --port 8765
```

浏览器打开 `http://192.168.0.111:8765`。默认只显示有 result 的待标注条目；“全部”包含没有结果的 source 和 source_err 样例。支持 PNG/JPG/JPEG/WebP。

- 左侧同时显示 source 原图和 edited 中间图；点击任意图片可放大。缺少 edited 时显示提示。
- 右侧并排显示各版本 3D 皮肤与 UV 贴图。拖动、滚轮和视角按钮会同步各版本；可查看头部、背面、隐藏外层或只看 UV。
- 点击“选为最佳”或按数字键 1–9，自动保存并进入下一项。
- 每个版本下方依次提供“选为最佳”“选为最佳（完美）”“修复并选为最佳（完美）”。
- 完美选择同时写入 `{id}_best.txt` 和 `{id}_perfect.txt`，两者都记录当前 result 文件名。
- 修复按钮打开从 `entropydrop_frontend` 移植的皮肤编辑器：左键绘制、右键旋转，支持外层、取色、橡皮擦、撤销/重做、色相/饱和度/亮度/对比度、K-Means 减色和模型转换。编辑对象需为 64×64 或 64×32 皮肤。
- 提交修复时保存 64×64 `{id}_perfect.png`，并将原 result 文件名写入 `_best.txt`、`_perfect.txt`；原 result 图片不变。取消弹窗不保存。重新打开同一完美版本的编辑器会继续编辑已保存的修复图。
- 所有 result 都不好时，点击“结果都不满意”；如果问题出在 edited 中间图，点击“edited 不满意”。两种标记都会保存并进入下一项。
- “暂时忽略”（S）不写文件，只在本次页面内暂时跳过。下次打开或刷新页面，未标注条目仍可选择。
- “上一个”（←）可回看刚才的条目。“已标注”包含已选最佳和已标记不满意的条目；“不满意”单独查看后者。可以重选、修改不满意原因或撤销。
- “已标注”内可按完美、最佳（含完美）、仅最佳（无完美）、结果都不满意、edited 不满意筛选，并与模型和编号搜索组合使用。
- 模型筛选及进度跨该模型下的全部前缀目录汇总；下拉框不会逐个列出前缀。条目仍显示实际目录，标注写回图片旁。
- “刷新目录”重新扫描新增/删除的图片；如果原最佳图片已删除，条目会恢复为待标注。

## 文件结构

工具代码与数据图片分开存放；`--root` 可指定数据集根目录、单个模型目录或单个前缀目录，标注文件始终写回对应图片所在目录。请保留仓库根目录的 `dataset_layout.py`，它提供读取和写入共用的目录规则。

```text
SKING_DDJ_Dataset/
├── dataset_layout.py          # 共用的三字符前缀规则与旧布局识别
├── best_annotator/
│   ├── app.py                 # Python HTTP 服务、扫描、标注保存与冲突检查
│   ├── index.html             # Vite 构建入口
│   ├── package.json           # 前端依赖与开发/构建/测试命令
│   ├── package-lock.json      # 固定依赖版本，配合 npm ci
│   ├── vite.config.js         # 构建输出与开发 API 代理
│   ├── src/
│   │   ├── main.jsx           # React 标注页、筛选和编辑弹窗
│   │   ├── viewers.js         # 候选皮肤 3D 预览与视角同步
│   │   ├── style.css          # 标注页及弹窗布局
│   │   ├── editor.css         # 编辑器 Tailwind 样式入口
│   │   └── editor/
│   │       ├── SkinEditor.tsx # 绘制、取色、调色、撤销/重做和提交
│   │       ├── icons.ts       # 本地图标集合
│   │       ├── components/   # MC.tsx 模型与 utils.ts 皮肤工具
│   │       └── utils/        # skin2dRenderer.ts 二维渲染工具
│   ├── public/vendor/        # 随构建复制的 skinview3d 与许可证
│   ├── static/               # Python 实际提供的生产构建；勿手工修改
│   │   ├── index.html
│   │   ├── assets/           # 带内容哈希的 JS/CSS，构建时重新生成
│   │   └── vendor/
│   ├── test_app.py           # 原有标注与 HTTP 接口测试
│   ├── test_perfect.py       # 完美、修复图片和写入失败回滚测试
│   └── test_ui.cjs           # React 界面流程测试
└── entropydrop_website_generations/
    └── SKING_DDJ_v61/
        └── ABC/
            ├── ABC_source.png
            ├── ABC_edited.png
            ├── ABC_result.png
            ├── ABC_result_v104.png
            ├── ABC_author.json
            ├── ABC_best.txt       # 选中时生成
            ├── ABC_perfect.txt    # 完美标注时生成
            └── ABC_perfect.png    # 只有提交修复后才生成
```

以上数据示例表示“已修复并选为最佳（完美）”。不同目录中的同名 ID 分别作为独立条目，候选与标注不会跨目录关联。条目以 `_source` 或 `_source_err` 图片为入口；只有 result 而没有 source 的文件不会单独形成标注条目。普通 source/edited 与对应 `_err` 文件同时存在时，优先使用普通文件。

前缀按 ID 的前三个字符原样截取，保留数字与大小写；不足三个字符时使用整个 ID。例如 `2L4DPU434KNC82YY` 位于 `SKING_DDJ_v61/2L4/`。source、edited、result、作者 JSON、提示词、偏好标注及修复图都留在同一前缀目录。

| 数据文件 | 用途与内容 |
| --- | --- |
| `{id}_source.<ext>` / `{id}_source_err.<ext>` | 原图；`ext` 支持 png、jpg、jpeg、webp。 |
| `{id}_edited.<ext>` / `{id}_edited_err.<ext>` | 可选中间图，同时作为编辑弹窗参考图；不是手工修复后的皮肤。 |
| `{id}_result.<ext>` / `{id}_result_{version}.<ext>` | 原版及各版本候选；`_result_err` 也作为候选识别。 |
| `{id}_best.txt` | UTF-8 单行原候选文件名，末尾换行；无目录前缀。 |
| `{id}_perfect.txt` | 完美标注，格式同 best，内容必须与 best 一致。 |
| `{id}_perfect.png` | 从选中的候选修复得到的 64×64 PNG；保留原候选，不加入 result 候选列表。 |
| `{id}_all_rejected.txt` | 单行 `result_unsatisfied` 或 `edited_unsatisfied`，末尾换行。 |
| `{id}_author.json` / `{id}_prompt.txt` / `*.uv_review.json` | 数据集中的作者、提示词及审计附加文件；标注工具不修改。 |

### 各标注状态对应的文件

下表描述通过工具保存后的状态，“—”表示该文件不存在：

| 状态 | `_best.txt` | `_perfect.txt` | `_perfect.png` | `_all_rejected.txt` |
| --- | --- | --- | --- | --- |
| 未标注 / 撤销后 | — | — | — | — |
| 普通最佳 | 原候选文件名 | — | — | — |
| 直接选为完美 | 原候选文件名 | 同 best | — | — |
| 修复后选为完美 | 原候选文件名 | 同 best | 修复后的皮肤 | — |
| 结果都不满意 | — | — | — | `result_unsatisfied` |
| edited 不满意 | — | — | — | `edited_unsatisfied` |

例如修复 `ABC_result_v104.png` 后，`ABC_best.txt` 和 `ABC_perfect.txt` 都写入 `ABC_result_v104.png`，而不是 `ABC_perfect.png`。读取最终皮肤时，先确认完美标注与有效的 best 一致且没有不满意冲突：若同时存在修复图，使用 `ABC_perfect.png`；否则读取 best 指向的原候选。仅看到 `_perfect.png` 文件不能证明条目有有效完美标注。

“暂时忽略”不改变任何文件，也不清除已有标注。没有标注文件只表示未作决定，不等于不满意。每个 ID 只保留当前一份修复图；再次提交会替换它。

## 标注格式

在对应图片的同一目录写入 UTF-8 文件 `{id}_best.txt`，内容只有选中的 result 文件名和换行，例如：

```text
14CN7VTM7MBVWXV6_result_v104.png
```

不满意时在图片的同一目录写入 `{id}_all_rejected.txt`，内容为以下其中一种，加一个换行：

| 按钮 | 文件内容 |
| --- | --- |
| 结果都不满意 | `result_unsatisfied` |
| edited 不满意 | `edited_unsatisfied` |

最佳结果与不满意标记互斥：改选最佳会移除旧的 `_all_rejected.txt`；标记不满意会移除旧的 `_best.txt`。撤销会清除该条目的标注。“暂时忽略”始终不写文件。

普通最佳、不满意和撤销会移除该条目旧的 `_perfect.txt`、`_perfect.png`；直接选择完美会移除旧修复图。修复仅写入独立的 `_perfect.png`。保存会验证 source 和对应图片仍存在，以临时文件 + 原子替换写入，并同时检查最佳/不满意/完美标注及修复图的版本，拒绝覆盖另一页面的新决定。多文件写入过程中出现 I/O 错误会尝试恢复此前文件；这不是跨进程或断电事务，建议单个服务实例管理目录。缺少 edited 时无法标记 edited 不满意，缺少 result 时无法标记结果都不满意。数据以磁盘文件为准，重启服务后仍有效。

如果外部编辑导致最佳与不满意标记同时存在，工具会提示重新选择，避免把冲突记录当作已完成。

部署启动时的后台进程号和日志位于本目录 `server.pid`、`server.log`。重新启动前应先结束原进程，或使用另一个端口。

## 前端开发

在 `best_annotator` 目录执行：

```bash
npm ci
npm run build
```

构建结果输出至 `static/`，随后按上方命令启动或重启 Python 服务。开发热更新可在 Python 服务使用 8765 端口时另开终端运行 `npm run dev`，Vite 会代理 `/api` 和 `/media`。

`src/main.jsx` 是 React 标注页面；`src/editor/` 是本地独立移植的编辑器和 Minecraft 模型组件，移除了原站的登录、收藏上传等业务依赖。编辑器按需加载。

## 检查

```bash
python3 -m unittest discover -p "test_*.py"
```

测试使用临时数据，不写真实数据集的标注。

界面流程另有 `test_ui.cjs`，使用本地已有的 `jsdom`，通过真实 Python HTTP 处理器在临时目录验证两种不满意标记、跳转、重选、撤销和并发页面，无需开启端口：

```bash
npm ci
npm test
```

3D 组件：[skinview3d 3.4.2](https://github.com/bs-community/skinview3d)，MIT 许可证，见 `static/vendor/skinview3d-LICENSE`。