创游世界资料库
一个面向 玩家学习、资料整理、AI 检索、脚本研究与长期维护 的创游世界中文知识库。
在线入口
如果你只是想查资料,推荐优先访问在线文档站:
- 在线文档站:https://cysjdocs.dpdns.org/
- GitHub 仓库:https://github.com/Azek431/cysj-data
- Gitee 镜像:https://gitee.com/Azek431/cysj-data
常用入口:
项目简介
本项目持续收集、归档并结构化整理与 创游世界 相关的资料,内容涵盖:
- 脚本系统
- 积木机制
- 变量与广播
- UI 交互
- 组件机制
- 项目设计
- 官方教程资料
- OCR 识别资料
- 引擎更新内容
- 维护报告与研究路线
它的目标不只是“存资料”,而是把分散内容整理成一个:
可导航、可追溯、可检索、可持续维护的中文知识库。
这个资料库适合谁?
| 用户类型 | 适合用途 |
|---|---|
| 新手玩家 | 按路线学习创游世界基础概念、教程资料和项目设计 |
| 创作者 | 查找脚本、变量、广播、UI、组件和玩法系统设计资料 |
| 资料整理者 | 维护 OCR、截图证据、编号映射、专题研究和待验证清单 |
| AI / RAG 使用者 | 将资料作为中文知识库语料,用于检索、问答和辅助整理 |
| 开源维护者 | 参与文档结构、导航、元数据、证据等级和内容质量优化 |
仓库亮点
- 资料可导航:通过首页、总导航、新手路线、按问题查资料、自动目录降低查找成本。
- 结论可追溯:尽量让重要结论能回到截图、OCR、官方内容或专题整理。
- 内容可检索:基于 VitePress 构建文档站,支持本地搜索与结构化阅读。
- 维护可持续:通过 frontmatter、侧边栏生成脚本、UI 检查脚本和维护报告降低长期维护成本。
- 适合 AI 检索:保留
llms.txt、OCR 资料、专题文档和证据等级说明,方便后续知识库构建。
推荐阅读路线
我是新手,完全不知道从哪里开始
我想学习脚本和积木
我想做一个完整作品
我想查原始资料和证据
本地运行
本项目使用 VitePress 构建文档站。
安装依赖:
bash
pnpm install启动本地预览:
bash
pnpm run docs:dev仅启动开发服务器,不自动检查:
bash
pnpm run docs:dev:host预览构建产物:
bash
pnpm run docs:preview日常维护命令
日常改文档时,不需要每次都完整构建。
生成侧边栏和自动目录
bash
pnpm run docs:sidebar检查 frontmatter
bash
pnpm run docs:frontmatter:check检查文档站 UI 关键文件
bash
pnpm run docs:ui:check准备发版或部署前构建
bash
pnpm run docs:build清理后重新构建
bash
pnpm run docs:fresh推荐维护节奏
| 场景 | 推荐操作 |
|---|---|
| 只改普通 Markdown | 本地预览即可 |
| 新增或移动文档 | 执行 pnpm run docs:sidebar |
| 修改 frontmatter | 执行 pnpm run docs:frontmatter:check |
| 修改主题、布局、CSS | 执行 pnpm run docs:ui:check |
| 准备发布版本 | 执行 pnpm run docs:build |
| Cloudflare 部署失败 | 查看部署日志,再本地复现构建 |
仓库结构
txt
cysj-data
├── docs
│ ├── index.md # 文档站首页
│ ├── 总索引与导航 # 总导航、新手路线、按问题查资料、自动目录
│ ├── 脚本系统 # 脚本界面、积木、变量、广播、数据流等
│ ├── 项目设计 # 项目架构、玩法系统、UI、教程引导
│ ├── OCR资料 # OCR 导航、识别结果、证据链、完整化表
│ ├── 核心研究 # 机制分析、专题研究、能力边界
│ ├── 教程资料 # 官方教程、视频资料、学习材料
│ ├── 引擎更新 # 版本更新、能力变化、兼容性观察
│ ├── 元信息 # 标签体系、术语表、证据等级、状态规范
│ ├── 维护与报告 # 维护报告、错误点、优化点、路线图
│ ├── public # 静态资源、robots.txt、llms.txt
│ └── .vitepress # VitePress 配置、主题、侧边栏
├── scripts # 自动侧边栏、清理、检查脚本
├── 资料 # 原始资料、截图、历史整理资料
├── package.json
├── pnpm-lock.yaml
├── README.md
└── LICENSE主要内容分类
总索引与导航
用于帮助用户快速进入不同资料区:
- 知识库总导航
- 新手阅读路线
- 按问题查资料
- 自动生成文档目录
脚本系统
用于整理创游世界脚本相关内容:
- 脚本界面
- 积木能力
- 变量机制
- 广播事件
- 作用域与数据流
- 系统级脚本能力
- 脚本实战架构
项目设计
用于整理作品设计与实战结构:
- 项目结构
- 游戏系统
- UI 交互
- 商店系统
- 地图切换
- 新手引导
- 玩法设计
OCR 资料
用于保存资料来源和证据链:
- OCR 原始识别内容
- OCR 完整化总表
- 图片编号映射
- 证据链说明
- 缺失资料与待补清单
元信息
用于维护知识库规则:
- 术语表
- 标签体系
- 文档状态
- 资料证据等级
- frontmatter 规范
- 分类与命名规则
维护与报告
用于记录长期维护过程:
- 维护报告
- 错误点与优化点
- 版本复盘
- 后续路线图
- 待验证问题
文档状态与证据等级
为了避免把“推测”写成“确定结论”,本项目会逐步标记文档状态和证据等级。
文档状态
| 状态 | 含义 |
|---|---|
| 草稿 | 初步记录,结构和结论仍可能变化 |
| 整理中 | 已开始分类和归纳,但仍需补充 |
| 已整理 | 已完成基础结构整理 |
| 已结构化 | 具备较完整的层级、索引和交叉链接 |
| 待验证 | 包含证据不足或需要复核的内容 |
| 已复核 | 主要来源和结论已完成核对 |
证据等级
| 等级 | 名称 | 含义 |
|---|---|---|
| E1 | 原始证据 | 来自截图、界面、OCR、官方内容或原始记录 |
| E2 | 整理证据 | 基于多个原始资料进行整理、分类和归纳 |
| E3 | 研究结论 | 基于已有资料进行人工分析、总结和解释 |
| E4 | 待验证内容 | 暂时缺少足够证据,需要后续继续验证 |
详细说明见:
新增文档建议
新增文档时,建议优先补充 frontmatter:
yaml
---
title: 文档标题
description: 简要说明这篇文档解决什么问题。
category: 分类名称
tags:
- 创游世界
- 脚本
- 项目设计
status: 整理中
evidence: E3
---推荐正文结构:
md
# 文档标题
## 这篇文档适合谁?
说明目标读者。
## 你能学到什么?
列出主要内容。
## 正文内容
展开说明。
## 相关文档
补充相关阅读入口。
## 待补充内容
记录后续需要完善的地方。维护原则
本项目长期遵守以下原则:
- 不随意删除原始资料:原始截图、OCR、历史资料优先保留。
- 不把待验证内容写死:不确定内容应明确标记“待验证”。
- 结论尽量有来源:重要结论尽量关联截图、OCR、官方内容或专题整理。
- 新增内容要挂入口:新增高价值文档后,应同步更新导航、索引或阅读路线。
- 优先改善可读性:比起盲目增加数量,更重视分类清晰、标题准确、路径好找。
- 兼顾用户和 AI 检索:标题、描述、标签、证据等级应尽量清晰稳定。
贡献建议
如果你想参与维护,可以优先从这些方向入手:
- 修正文档错别字、失效链接和格式问题
- 补充脚本系统、变量、广播、UI、组件等资料
- 补充 OCR 原始资料、编号映射和证据链
- 给重点文档补 frontmatter、标签和证据等级
- 把零散内容整理成专题文档
- 给新增内容补充导航入口和关联阅读
- 反馈错误结论、重复资料或分类不清晰的问题
建议提交前至少检查:
bash
pnpm run docs:sidebar
pnpm run docs:frontmatter:check
pnpm run docs:ui:check部署说明
当前文档站适合部署到 Cloudflare Pages、GitHub Pages、Netlify 或其他静态站点托管平台。
常规构建命令:
bash
pnpm run docs:build构建产物默认输出到:
txt
docs/.vitepress/dist如果使用 Cloudflare Pages,可将构建命令设置为:
bash
pnpm install --frozen-lockfile && pnpm run docs:build输出目录设置为:
txt
docs/.vitepress/dist发布版本建议
发布新版本时,建议按下面顺序检查:
- 本地预览主要页面
- 运行 frontmatter 检查
- 运行 UI 检查
- 必要时运行完整构建
- 推送到 GitHub
- 等待 Cloudflare Pages 自动部署
- 打开线上网站确认首页、搜索、导航是否正常
- 发布 GitHub Release
推荐提交信息格式:
txt
优化:首页结构与资料库入口
新增:按问题查资料导航页
新增:资料证据等级说明
优化:添加 Gitee 镜像仓库入口
修复:处理文档链接与导航异常使用场景
本项目适合用于:
- 学习创游世界基础操作和脚本系统
- 查找创游世界项目设计资料
- 研究变量、广播、UI、组件和系统机制
- 整理 OCR 资料和截图证据链
- 构建创游世界相关 AI 知识库
- 作为 RAG 检索语料或问答参考资料
- 长期维护中文游戏创作资料库
联系方式
- 作者:@Azek431
- GitHub:https://github.com/Azek431/cysj-data
- Gitee:https://gitee.com/Azek431/cysj-data
- QQ 交流群:1097265516
- Telegram 主频道:https://t.me/AzekMain
License
本项目使用 MIT License。
Star 支持
如果这个资料库对你有帮助,欢迎点一个 Star 支持一下。
也欢迎反馈错误、补充资料、参与整理,让创游世界相关资料变得更系统、更清晰、更容易被找到。
