开发与文档维护
游戏代码、客户端和这份玩家手册在同一个 pnpm workspace 中维护。修改游戏功能时,可以在同一项改动中更新对应手册,让说明随版本一起发布。
项目入口
工程文档中包含设计方案和待办;是否可玩、是否可下载,以玩家手册与实际发布状态为准。
本地阅读与检查
在仓库根目录运行:
sh
pnpm install
pnpm docs:dev开发服务器启动后会显示本地地址。完整检查和预览:
sh
pnpm docs:typecheck
pnpm docs:build
pnpm docs:preview构建会检查手册内部链接,并生成静态 HTML 和中文本地搜索索引;不需要下载游戏媒体,也不需要云服务凭证。
内容组织
| 目录 | 用途 |
|---|---|
docs/game/ | 游戏世界、角色与载具、玩法设定 |
docs/guide/ | 面向玩家的操作、玩法、存档、安装与常见问题 |
docs/ | 手册首页与项目入口 |
docs/.vitepress/ | 站点配置与游戏风格主题 |
docs/*.md、docs/releases/ | 原有工程文档与发布证据,保留原路径 |
页面下方的“在 GitHub 上改进本页”链接直接指向对应 Markdown。安装页的版本与包地址读取仓库中的客户端发布清单,避免另写一份下载目录。
手册目前是独立静态站点,尚未内嵌到游戏或安装包中。游戏内的新手教程和操作说明继续可用;后续离线手册可从 docs/guide/ 生成,不需要另建内容副本。