一页纸解决「接手时不知道从哪读、哪些不能碰、改完怎么验」: - 0 组件与端口速览;1 必读顺序(踩坑记录 P-001/P-002/P-011 列为首要)+ 按改动选文档 - 2 硬规则 R1–R9:DLL 与 exe 成对、改 DLL 要补 CRC 并重编服务端、Z 盘只是部署副本、 gmweb 只能 IE11、静态 no-store、sys.executable 陷阱、不提交产物、版本号三处一致、声明与 GPL - 3 构建命令(服务端三个 exe / 启动器单文件 / 客户端补丁 / PVF 导出) - 4 代码地图:server.py 按功能给出行号区间,其余给模块职责 - 5 验证方法:进程端口、启动器日志、CRC verify、diff -rq, 以及本项目一直在用的「静态服务 + 无头浏览器截图/量 rect」手法,附分场景清单 - 6 发版七项清单;7 当前状态;8 提交约定;9 不要做的事 - CLAUDE.md 作为指向 AGENTS.md 的兼容入口;根 README 顶部与文档索引、docs/README 同步挂上
33 lines
2.4 KiB
Markdown
33 lines
2.4 KiB
Markdown
# 开发文档索引
|
||
|
||
本目录汇总各子项目的开发文档。
|
||
|
||
| 文档 | 内容 |
|
||
|------|------|
|
||
| [../AGENTS.md](../AGENTS.md) | **入口文件**:给 AI / 新人的一页纸——硬规则、构建命令、验证方法、代码地图、发版清单(开工前先读这份) |
|
||
| [开发文档.md](开发文档.md) | **GM 启动器 / 整合工具** 完整开发文档(环境搭建、架构、API 契约、打包部署、常见问题) |
|
||
| [服务端开发文档.md](服务端开发文档.md) | **服务端(Go)** 架构、GM 接口契约、拍卖行/背包改动、编译部署 |
|
||
| [PVF解析开发文档.md](PVF解析开发文档.md) | **PVF 解析** 套件(pvfine)、pvfexport 工具、离线名称显示集成 |
|
||
| [客户端补丁与CRC校验.md](客户端补丁与CRC校验.md) | **客户端补丁(90CN.dll)** 自校验机制、`patch_dll_crc.py` 用法、与「服务端 DLL 指纹」的区别、排查手册 |
|
||
| [启动器窗口风暴排查.md](启动器窗口风暴排查.md) | **启动器重复开窗口 / 页面空白** 的根因(打包后 `sys.executable` 指向自身)、复现手法、修复点与日志判读 |
|
||
| [踩坑记录.md](踩坑记录.md) | **踩坑合集**(13 条):每条只写现象 / 成因 / 为什么没早发现 / 教训,开头是一句话教训总表,结尾是发版检查清单 |
|
||
| [launcher-README.md](launcher-README.md) | 整合启动器 + GM 工具的原始 README |
|
||
|
||
其余子项目的 README 分散在各自目录:
|
||
|
||
- `server/README.md` — 服务端源码说明
|
||
- `pvf/README.md` — pvfine 项目说明
|
||
- `gmtool/README.md` — GM 工具旧版说明
|
||
|
||
---
|
||
|
||
## 快速上手路径
|
||
|
||
0. **任何人(含 AI)接手**:先读 [../AGENTS.md](../AGENTS.md),再回来按场景选文档。
|
||
1. **只想跑起来**:看根目录 [README](../README.md) 的「快速开始」。
|
||
2. **改 GM 工具(启动器)**:看 [开发文档.md](开发文档.md)。
|
||
3. **改服务端 GM 接口**:看 [服务端开发文档.md](服务端开发文档.md) 的「GM 接口契约」。
|
||
4. **改 PVF 解析 / 物品名**:看 [PVF解析开发文档.md](PVF解析开发文档.md)。
|
||
5. **改客户端补丁 / 重编 DLL**:看 [客户端补丁与CRC校验.md](客户端补丁与CRC校验.md)——改完 DLL 要补 CRC,并且要重编服务端。
|
||
6. **遇到怪问题先翻 [踩坑记录.md](踩坑记录.md)**:13 条坑的一句话教训和判断规则,可能已经记过了。
|