docs 目录分类对照表
1. 文档目的
本文档解释 docs/ 目录下每个子目录的定位、核心作用与代表文档,帮助你快速找到适合的内容。
2. 目录结构一览
docs/
├── 总索引与导航/ # 首页入口、新手路线、全库导航
├── 教程资料/ # 官方教程、学习路线、素材与组件关系
├── 脚本系统/ # 脚本界面、积木能力、作用域、组件系统
├── 核心研究/ # API、变量、广播、UI、组件系统专题导航
├── 项目设计/ # 项目结构、系统设计、教程引导
├── OCR资料/ # 截图转文本、映射表、证据链
├── 引擎更新/ # 版本能力变化、联机演进
├── 社区分析/ # 社区观察、待验证问题
├── 维护与报告/ # 维护规范、更新日志、问题清单
├── 元信息/ # 术语表、标签体系、文档状态
├── guide/ # VitePress 默认示例文档
├── AI优化输出/ # AI 优化相关输出内容
└── 待整理/ # 临时待整理区域(空目录)3. 各目录详细说明
3.1 总索引与导航
定位:全库入口与导航聚合页。
核心内容:
- 新手阅读路线
- 知识库总导航
- docs 目录分类对照表
代表文档:
新手阅读路线.md- 新手入门第一步创游世界知识库总导航.md- 全库内容聚合docs 目录分类对照表.md- 本文档
适合谁:
- 首次访问资料库的用户
- 想快速找到入口的用户
3.2 教程资料
定位:官方教程整合与学习路径规划。
核心内容:
- 官方教程截图 OCR 全文
- B站视频资源清单
- 学习路线图
- 对象/素材/组件/脚本关系总图
- UI系统与切换机制
- 广播机制深度解析
- 素材系统与组件挂载
- 从视频学习到实战落地指南
代表文档:
官方教程知识索引.md- 官方教程 OCR 全文索引专题研究/创游世界学习路线图.md- 学习阶段规划专题研究/创游世界对象_素材_组件_脚本关系总图.md- 核心概念关系专题研究/广播机制深度解析.md- 广播机制详解
适合谁:
- 刚接触创游世界的新手
- 想系统学习官方教程的用户
- 想了解视频学习资源的人
3.3 脚本系统
定位:创游世界脚本能力体系的核心文档库。
核心内容:
- 脚本界面与积木知识索引
- 自定义组件解析
- 脚本作用域与数据流
- 系统级脚本能力
- 组件体系与能力分层
- API 整理
- 各类系统设计入门(战斗、背包、任务、交互、存档等)
- 项目结构模板
- UI数据同步架构
- 广播驱动项目结构
- 新手常见卡点与避坑
代表文档:
脚本界面与积木知识索引.md- 脚本系统总入口专题研究/自定义组件深度解析.md- 组件核心能力专题研究/脚本作用域与数据流深度研究.md- 变量分层专题研究/创游世界UI数据同步架构.md- UI与数据同步专题研究/创游世界新手常见卡点与避坑清单.md- 新手避坑
适合谁:
- 想深入理解脚本系统的用户
- 想做项目但不知道如何架构的用户
- 想了解组件、自定义组件、广播等核心概念的开发者
3.4 核心研究
定位:核心机制研究的专题导航聚合页。
核心内容:
- 脚本系统研究导航
- UI与交互研究导航
- 专题研究导航
- 广播与事件机制导航
- 数据、变量与作用域导航
- 版本与能力边界导航
- 组件与对象系统导航
- API与脚本接口导航
代表文档:
专题研究导航.md- 核心研究总入口脚本系统研究导航.md- 脚本能力研究导航UI与交互研究导航.md- UI与交互研究导航
适合谁:
- 进阶用户
- 想深入研究某个专题的开发者
- 想找专题研究入口的 AI 检索系统
3.5 项目设计
定位:面向"真正要做项目"的实践指南。
核心内容:
- 项目设计导航
- 项目结构与架构导航
- 系统设计专题导航
- 商店系统专题
- 多地图与场景切换专题
- 教程引导与新手流程专题
- 脚本实战架构
- 广播驱动项目结构
- UI数据同步架构
代表文档:
项目设计导航.md- 项目设计总入口系统设计专题导航.md- 战斗/背包/任务/交互/存档系统入口商店系统专题导航.md- 商店与兑换系统多地图与场景切换导航.md- 多地图场景管理
适合谁:
- 想做完整项目的制作者
- 不知道如何架构项目的新手
- 想学习系统设计(战斗、背包、任务等)的开发者
3.6 OCR资料
定位:截图转文本与证据链管理。
核心内容:
- 脚本界面截图 OCR
- 官方教程截图 OCR
- 引擎更新截图 OCR
- 图片编号映射表
- OCR 完整化总表
- OCR 证据链说明
- OCR 证据使用规范
- OCR 专题回链示例
- OCR 未识别与残缺清单
代表文档:
OCR资料导航.md- OCR 资料总入口映射表/OCR 图片编号映射表.md- 截图编号与主题对照OCR 证据使用规范.md- 如何使用 OCR 证据OCR 完整化总表.md- OCR 完整度状态
适合谁:
- 想查证据、验证结论的用户
- 维护者进行 OCR 补全工作
- AI 检索系统进行证据溯源
3.7 引擎更新
定位:版本能力变化与功能演进追踪。
核心内容:
- 引擎更新知识索引(版本 4.33.86 ~ 4.54.0)
- 联机 UI 演进专题
- 4.54.0 数据类型与脚本能力升级解析
代表文档:
引擎更新知识索引.md- 版本更新总索引专题研究/联机UI演进专题.md- 联机 UI 演进详解专题研究/4.54.0 数据类型与脚本能力升级解析.md- 最新版本能力解析
适合谁:
- 想了解某功能何时加入的用户
- 想追踪版本差异的研究者
- 开发者了解最新能力边界
3.8 社区分析
定位:社区观察、逆向研究与待验证问题。
核心内容:
- 其他用户解析专题整理
- 社区分析待验证问题清单
- 脚本伪源码观察(专题研究)
- 类型转换现象整理(专题研究)
- 地图与对象结构猜想(专题研究)
- 3.x 与 4.x 可观察性差异(专题研究)
代表文档:
其他用户解析专题整理.md- 社区观察与逆向分析待验证问题清单.md- 需要验证的问题列表专题研究/创游脚本伪源码观察.md- 伪源码研究
适合谁:
- 想深入了解编辑器内部行为的研究者
- 想追踪待验证问题的维护者
- 对逆向分析有兴趣的用户
3.9 维护与报告
定位:资料库维护规范、更新日志与问题追踪。
核心内容:
- 维护与报告导航
- 社区贡献与维护指南
- 维护检查清单
- 维护流程说明
- 资料规范与状态总览
- 文档状态分级规则
- 待验证问题清单
- 后续研究路线图
- 更新日志入口导航
- 站点部署与运维方案
- 合规与版权声明
- AI 自动文档建设报告
代表文档:
维护与报告导航.md- 维护入口总览社区贡献与维护指南.md- 贡献指南待验证问题清单.md- 待验证问题追踪后续研究路线图.md- 研究方向规划
适合谁:
- 想参与资料库维护的贡献者
- 想知道资料库当前状态的用户
- AI 系统进行维护状态查询
3.10 元信息
定位:文档标准化规范与元数据管理。
核心内容:
- 页面模板与标准化文档结构
- 知识条目统一元数据规范
- 创游世界术语表
- 知识标签体系总表
- 知识库文档状态总表
- 创游世界资料库深入研究报告
代表文档:
页面模板.md- 新建文档的标准模板知识条目统一元数据规范.md- 元数据规范创游世界术语表.md- 术语统一说明
适合谁:
- 需要新建文档的贡献者
- 想了解文档规范的维护者
- AI 系统进行标准化检索
3.11 guide(VitePress 示例)
定位:VitePress 默认示例文档目录。
核心内容:
- getting-started.md
- markdown-examples.md
- api-examples.md
说明:这是 VitePress 默认生成的示例目录,非创游世界资料库核心内容。
3.12 AI优化输出
定位:AI 优化相关输出内容目录。
说明:用于存放 AI 优化过程中的输出文件,非核心文档区。
3.13 待整理
定位:临时待整理区域。
说明:当前为空目录,用于临时存放待整理内容(已迁移完毕)。
4. 快速定位表
| 你想做什么 | 推荐目录 |
|---|---|
| 新手入门 | 总索引与导航 / 教程资料 |
| 学习脚本 | 脚本系统 / 核心研究 |
| 做项目 | 项目设计 / 脚本系统 |
| 查证据 | OCR资料 |
| 了解版本变化 | 引擎更新 |
| 研究社区观察 | 社区分析 |
| 参与维护 | 维护与报告 / 元信息 |
| 标准化写作 | 元信息 |
5. 关联阅读
docs/总索引与导航/创游世界知识库总导航.mddocs/总索引与导航/新手阅读路线.mddocs/index.md
