# cysj-data

**Repository Path**: Azek431/cysj-data

## Basic Information

- **Project Name**: cysj-data
- **Description**: 创游世界脚本、组件、编辑器界面、对象结构、引擎更新与教程资料的开源资料库，并持续更新优化
- **Primary Language**: Shell
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://cysjdocs.dpdns.org/
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-05-09
- **Last Updated**: 2026-07-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Azek创游世界文档

> 面向玩家学习、资料整理、AI 检索、脚本研究与长期维护的创游世界中文知识库。

<p align="center">
  <a href="https://cysjdocs.azek431.top/">
    <img src="https://img.shields.io/badge/在线文档-Azek创游世界文档-2563eb?style=for-the-badge" alt="在线文档" />
  </a>
  <a href="https://github.com/Azek431/cysj-data">
    <img src="https://img.shields.io/badge/GitHub-Azek431%2Fcysj--data-111827?style=for-the-badge&logo=github" alt="GitHub 仓库" />
  </a>
  <a href="https://gitee.com/Azek431/cysj-data">
    <img src="https://img.shields.io/badge/Gitee-镜像仓库-c71d23?style=for-the-badge" alt="Gitee 镜像" />
  </a>
</p>

<p align="center">
  <img src="https://img.shields.io/badge/内容-脚本%20%2F%20组件%20%2F%20UI%20%2F%20OCR%20%2F%20项目设计-orange" alt="内容范围" />
  <img src="https://img.shields.io/badge/状态-持续整理中-brightgreen" alt="项目状态" />
  <img src="https://img.shields.io/badge/文档引擎-VitePress-blue" alt="VitePress" />
  <a href="./LICENSE">
    <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License" />
  </a>
</p>

---

## 在线入口

如果你只是想查资料，推荐优先访问在线文档站，而不是直接翻仓库文件。

- 在线文档站：https://cysjdocs.azek431.top/
- GitHub 仓库：https://github.com/Azek431/cysj-data
- Gitee 镜像：https://gitee.com/Azek431/cysj-data

常用入口：

- [资料库首页](https://cysjdocs.azek431.top/)
- [新手阅读路线](https://cysjdocs.azek431.top/总索引与导航/新手阅读路线)
- [按问题查资料](https://cysjdocs.azek431.top/总索引与导航/按问题查资料)
- [创游世界知识库总导航](https://cysjdocs.azek431.top/总索引与导航/创游世界知识库总导航)
- [脚本系统](https://cysjdocs.azek431.top/脚本系统/脚本界面与积木知识索引)
- [项目设计](https://cysjdocs.azek431.top/项目设计/项目设计导航)
- [OCR 资料导航](https://cysjdocs.azek431.top/OCR资料/OCR资料导航)
- [资料证据等级说明](https://cysjdocs.azek431.top/元信息/资料证据等级说明)

---

## 项目简介

本项目持续收集、归档、整理并结构化创游世界相关资料，目标是把零散内容整理成一个长期可维护、可搜索、可追溯的中文知识库。

资料库内容包括但不限于：

- 创游世界基础教程
- 脚本系统与积木机制
- 变量、广播、事件、作用域与数据流
- UI 交互、按钮、弹窗、界面设计
- 组件机制、项目结构和系统设计
- 商店、背包、货币、存档、地图、新手引导等项目设计专题
- OCR 识别资料、截图证据、图片编号映射和证据链说明
- 官方教程、视频资料、引擎更新和社区观察
- 维护报告、内容审计、资料状态和后续路线图

这个仓库的目标不是单纯“堆资料”，而是把内容整理成：

> **可导航、可追溯、可检索、可维护、适合玩家学习，也适合 AI 检索的中文资料库。**

---

## 这个资料库适合谁？

| 用户类型 | 适合用途 |
|---|---|
| 新手玩家 | 按路线学习创游世界基础概念、教程资料和项目设计 |
| 创作者 | 查找脚本、变量、广播、UI、组件和玩法系统设计资料 |
| 项目作者 | 参考商店、背包、存档、地图、任务、新手引导等系统设计方案 |
| 资料整理者 | 维护 OCR、截图证据、编号映射、专题研究和待验证清单 |
| AI / RAG 使用者 | 将资料作为中文知识库语料，用于检索、问答和辅助整理 |
| 开源维护者 | 参与文档结构、导航、元数据、证据等级和内容质量优化 |

---

## 仓库亮点

- **资料可导航**：通过首页、总导航、新手路线、按问题查资料、分类导航和自动目录降低查找成本。
- **结论可追溯**：重要结论尽量回到截图、OCR、官方内容、专题研究或维护记录。
- **内容可检索**：基于 VitePress 构建文档站，支持结构化阅读和本地搜索。
- **维护可持续**：通过 frontmatter、侧边栏生成脚本、UI 检查脚本、链接修复脚本和内容审计脚本降低长期维护成本。
- **适合 AI 检索**：保留 `llms.txt`、OCR 资料、专题文档、证据等级和结构化入口，方便后续用于 AI / RAG 知识库。
- **开源反馈友好**：提供 GitHub Issue 模板，方便反馈文档错误、失效链接、OCR 修正、资料建议和站点体验问题。

---

## 当前维护重点

当前资料库主要围绕以下方向继续优化：

1. 提升文档站 UI 美观性、阅读体验和移动端表现。
2. 整理脚本系统、变量、广播、UI、项目设计等重点专题。
3. 清理重复、过期、散落、缺证据或导航不清晰的文档。
4. 补充 OCR 原始资料、证据链、图片编号映射和待验证内容。
5. 优化搜索、SEO、sitemap、robots.txt、缓存策略和 AI 检索友好度。
6. 增强自动化维护脚本，减少手动检查和重复整理成本。

---

## 推荐阅读路线

### 我是新手，完全不知道从哪里开始

推荐按这个顺序阅读：

1. [资料库首页](https://cysjdocs.azek431.top/)
2. [新手阅读路线](https://cysjdocs.azek431.top/总索引与导航/新手阅读路线)
3. [按问题查资料](https://cysjdocs.azek431.top/总索引与导航/按问题查资料)
4. [创游世界知识库总导航](https://cysjdocs.azek431.top/总索引与导航/创游世界知识库总导航)

适合场景：

- 第一次接触创游世界
- 不知道该从哪篇文档开始
- 想快速了解资料库结构
- 想按照学习路线逐步入门

### 我想学习脚本和积木

推荐按这个顺序阅读：

1. [脚本界面与积木知识索引](https://cysjdocs.azek431.top/脚本系统/脚本界面与积木知识索引)
2. [脚本实战架构入门](https://cysjdocs.azek431.top/脚本系统/专题研究/创游世界脚本实战架构入门)
3. [系统级脚本能力解析](https://cysjdocs.azek431.top/脚本系统/专题研究/系统级脚本能力解析)
4. [脚本作用域与数据流深度研究](https://cysjdocs.azek431.top/脚本系统/专题研究/脚本作用域与数据流深度研究)

适合场景：

- 想理解脚本界面和积木分类
- 想学习变量、广播、事件、条件判断
- 想把零散脚本组合成完整玩法系统
- 想理解脚本作用域、数据流和系统架构

### 我想做一个完整作品

推荐按这个顺序阅读：

1. [项目设计导航](https://cysjdocs.azek431.top/项目设计/项目设计导航)
2. [项目结构与架构导航](https://cysjdocs.azek431.top/项目设计/项目结构与架构导航)
3. [系统设计专题导航](https://cysjdocs.azek431.top/项目设计/系统设计专题导航)
4. [教程引导与新手流程导航](https://cysjdocs.azek431.top/项目设计/教程引导与新手流程导航)

适合场景：

- 想设计完整游戏结构
- 想做商店、背包、货币、任务、地图或新手引导
- 想避免项目越做越乱
- 想把玩法拆分成可维护的系统

### 我想查原始资料和证据

推荐按这个顺序阅读：

1. [OCR 资料导航](https://cysjdocs.azek431.top/OCR资料/OCR资料导航)
2. [OCR 当前状态与待补清单](https://cysjdocs.azek431.top/OCR资料/OCR%20当前状态与待补清单)
3. [OCR 完整化总表](https://cysjdocs.azek431.top/OCR资料/OCR%20完整化总表)
4. [OCR 证据链说明](https://cysjdocs.azek431.top/OCR资料/OCR%20证据链说明)
5. [资料证据等级说明](https://cysjdocs.azek431.top/元信息/资料证据等级说明)

适合场景：

- 想查 OCR 原始资料
- 想确认某个结论有没有证据
- 想查看图片编号或资料编号
- 想参与 OCR 修正和资料补全
- 想知道哪些内容仍然待验证

### 我想参与维护

推荐先看：

1. [内容质量审计清单](https://cysjdocs.azek431.top/维护与报告/内容质量审计清单)
2. [资料证据等级说明](https://cysjdocs.azek431.top/元信息/资料证据等级说明)
3. [导航体系说明](https://cysjdocs.azek431.top/总索引与导航/导航体系说明)
4. [维护与报告导航](https://cysjdocs.azek431.top/维护与报告/维护与报告导航)

适合场景：

- 想修复错别字和链接
- 想补充资料或 OCR
- 想整理历史报告
- 想参与文档结构和内容质量维护

---

## 本地运行

本项目使用 VitePress 构建文档站，推荐使用 pnpm 管理依赖。

### 安装依赖

```bash
pnpm install
```

### 启动本地开发预览

```bash
pnpm run docs:dev
```

### 仅启动开发服务器

```bash
pnpm run docs:dev:host
```

### 正式构建

```bash
pnpm run docs:build
```

### 预览构建产物

```bash
pnpm run docs:preview
```

构建产物默认输出到：

```txt
docs/.vitepress/dist
```

---

## 一键部署检查

本项目提供适合 Windows PowerShell / VSCode 终端使用的一键部署检查脚本。

推荐命令：

```bash
pnpm run docs:deploy
```

这个命令会自动完成：

1. 检查当前目录是否为项目根目录。
2. 检查 Node.js 与 pnpm 环境。
3. 生成 VitePress 侧边栏和自动目录。
4. 检查文档 frontmatter。
5. 检查文档站 UI 关键文件。
6. 执行 VitePress 正式构建。
7. 检查构建产物是否生成。

清理旧构建产物后重新检查：

```bash
pnpm run docs:deploy:clean
```

第一次在新电脑上运行，或者依赖可能不完整时：

```bash
pnpm run docs:deploy:full
```

说明：

- 本脚本不会自动 `git commit` 或 `git push`。
- 本项目推荐使用 VSCode Git UI 手动提交和同步。
- 推送到 GitHub 后，Cloudflare Pages 会自动部署线上文档站。
- Cloudflare Pages 的构建输出目录应保持为 `docs/.vitepress/dist`。

---

## 日常维护命令

日常改文档时，不需要每次都完整构建。

### 生成侧边栏和自动目录

```bash
pnpm run docs:sidebar
```

### 检查 frontmatter

```bash
pnpm run docs:frontmatter:check
```

### 检查文档站 UI 关键文件

```bash
pnpm run docs:ui:check
```

### 一键轻量检查

```bash
pnpm run docs:check
```

### 修复 Markdown 站内链接

```bash
pnpm run docs:links:fix
```

### 清理正文中的重复更新时间脚注

```bash
pnpm run docs:footers:fix
```

### 同步文档写作日期和更新日期

```bash
pnpm run docs:dates:fix
```

### 生成文档内容质量审计报告

```bash
pnpm run docs:content:audit
```

### 构建体积审计

```bash
pnpm run docs:size:audit
```

### 正式构建

```bash
pnpm run docs:build
```

---

## 推荐维护节奏

| 场景 | 推荐操作 |
|---|---|
| 只改普通 Markdown | 本地预览即可 |
| 新增或移动文档 | 执行 `pnpm run docs:sidebar` |
| 修改 frontmatter | 执行 `pnpm run docs:frontmatter:check` |
| 修改主题、布局、CSS | 执行 `pnpm run docs:ui:check` |
| 修复站内链接空格 | 执行 `pnpm run docs:links:fix` |
| 清理 AI 日期脚注 | 执行 `pnpm run docs:footers:fix` |
| 同步文档日期 | 执行 `pnpm run docs:dates:fix` |
| 做内容质量检查 | 执行 `pnpm run docs:content:audit` |
| 准备发布版本 | 执行 `pnpm run docs:build` |
| Cloudflare 部署失败 | 查看 Cloudflare Pages 部署日志，再本地复现构建 |

---

## 仓库结构

```txt
cysj-data
├── docs
│   ├── index.md
│   ├── 总索引与导航
│   ├── 脚本系统
│   ├── 项目设计
│   ├── OCR资料
│   ├── 核心研究
│   ├── 教程资料
│   ├── 引擎更新
│   ├── 元信息
│   ├── 维护与报告
│   ├── public
│   └── .vitepress
├── scripts
├── 资料
├── package.json
├── pnpm-lock.yaml
├── README.md
└── LICENSE
```

---

## 主要内容分类

### 总索引与导航

用于帮助用户快速进入不同资料区：

- 知识库总导航
- 新手阅读路线
- 按问题查资料
- 自动生成文档目录
- 导航体系说明

### 脚本系统

用于整理创游世界脚本相关内容：

- 脚本界面
- 积木能力
- 变量机制
- 广播事件
- 作用域与数据流
- 系统级脚本能力
- 脚本实战架构

### 项目设计

用于整理作品设计与实战结构：

- 项目结构
- 游戏系统
- UI 交互
- 商店系统
- 背包与货币
- 地图切换
- 存档系统
- 新手引导
- 玩法设计

### OCR 资料

用于保存资料来源和证据链：

- OCR 原始识别内容
- OCR 当前状态与待补清单
- OCR 完整化总表
- 图片编号映射
- 证据链说明
- 缺失资料与待补清单
- 历史 OCR 报告归档

### 元信息

用于维护知识库规则：

- 术语表
- 标签体系
- 文档状态
- 资料证据等级
- frontmatter 规范
- 分类与命名规则

### 维护与报告

用于记录长期维护过程：

- 维护报告（活跃维护文档）
- 错误点与优化点
- 内容质量审计清单
- 待验证问题清单
- 后续路线图
- 历史归档（审计报告、复盘记录等已归档历史文件）

---

## 文档状态与证据等级

为了避免把“推测”写成“确定结论”，本项目会逐步标记文档状态和证据等级。

### 文档状态

| 状态 | 含义 |
|---|---|
| 草稿 | 初步记录，结构和结论仍可能变化 |
| 整理中 | 已开始分类和归纳，但仍需补充 |
| 已整理 | 已完成基础结构整理 |
| 已结构化 | 具备较完整的层级、索引和交叉链接 |
| 待验证 | 包含证据不足或需要复核的内容 |
| 已复核 | 主要来源和结论已完成核对 |

### 证据等级

| 等级 | 名称 | 含义 |
|---|---|---|
| E1 | 原始证据 | 来自截图、界面、OCR、官方内容或原始记录 |
| E2 | 整理证据 | 基于多个原始资料进行整理、分类和归纳 |
| E3 | 研究结论 | 基于已有资料进行人工分析、总结和解释 |
| E4 | 待验证内容 | 暂时缺少足够证据，需要后续继续验证 |

详细说明：

- [资料证据等级说明](https://cysjdocs.azek431.top/元信息/资料证据等级说明)

---

## 文档元数据规范

新增或整理文档时，建议优先补充 frontmatter：

```yaml
---
title: 文档标题
description: 简要说明这篇文档解决什么问题。
category: 分类名称
tags:
  - 创游世界
  - 脚本
  - 项目设计
status: 整理中
evidence: E3
created: 2026-05-16
updated: 2026-05-16
---
```

推荐字段说明：

| 字段 | 说明 |
|---|---|
| `title` | 文档标题 |
| `description` | 文档摘要，用于搜索、SEO 和 AI 检索 |
| `category` | 所属分类 |
| `tags` | 标签，建议包含主题关键词 |
| `status` | 文档状态 |
| `evidence` | 证据等级 |
| `created` | 写作日期 |
| `updated` | 更新日期 |

---

## 推荐文档结构

新增教程或专题文档时，推荐使用下面结构：

```md
# 文档标题

## 这篇文档适合谁？

说明目标读者。

## 你能学到什么？

列出主要内容。

## 核心概念

解释基础概念。

## 最小可做版本

给出最简实现思路。

## 推荐变量设计

整理变量名、用途和作用范围。

## 推荐广播设计

整理广播名、触发方、接收方和用途。

## 常见错误

说明容易踩坑的地方。

## 相关文档

补充相关阅读入口。

## 待补充内容

记录后续需要完善的地方。
```

---

## 自动化维护脚本

本项目包含多种维护脚本，用于降低人工检查成本。

| 脚本 | 作用 |
|---|---|
| `generate-sidebar.mjs` | 生成侧边栏和自动文档目录 |
| `check-frontmatter.mjs` | 检查文档 frontmatter |
| `check-docs-ui.mjs` | 检查主题、布局、UI、静态文件是否存在 |
| `fix-md-links.mjs` | 修复 Markdown 站内链接中的空格问题 |
| `remove-ai-footers.mjs` | 清理正文中重复的更新时间/维护者脚注 |
| `sync-doc-dates.mjs` | 同步文档写作日期和更新日期 |
| `audit-doc-content.mjs` | 生成文档内容质量审计报告 |
| `mark-search-excluded.mjs` | 排除低价值页面进入本地搜索索引 |
| `audit-dist-size.mjs` | 审计构建产物体积 |
| `deploy-docs.ps1` | Windows PowerShell 一键部署检查脚本 |

---

## 问题反馈

如果你发现文档错误、链接失效、OCR 识别问题，或者希望补充新资料，可以通过 GitHub Issues 反馈：

- 文档内容错误：反馈错别字、错误结论、过期内容、缺少证据等问题。
- 失效链接 / 404：反馈站内链接打不开、跳转错误、锚点失效等问题。
- OCR 资料修正：反馈 OCR 识别错误、截图编号错误、证据链问题。
- 新资料 / 新专题建议：建议新增教程、专题或资料分类。
- 文档站体验问题：反馈首页、搜索、导航、移动端、深色模式等体验问题。

反馈入口：

```txt
https://github.com/Azek431/cysj-data/issues/new/choose
```

---

## 贡献建议

如果你想参与维护，可以优先从这些方向入手：

- 修正文档错别字、失效链接和格式问题
- 补充脚本系统、变量、广播、UI、组件等资料
- 补充项目设计、系统设计、实战教程和新手路线
- 补充 OCR 原始资料、编号映射和证据链
- 给重点文档补 frontmatter、标签和证据等级
- 把零散内容整理成专题文档
- 给新增内容补充导航入口和关联阅读
- 反馈错误结论、重复资料或分类不清晰的问题

提交前建议至少检查：

```bash
pnpm run docs:sidebar
pnpm run docs:frontmatter:check
pnpm run docs:ui:check
```

---

## 维护原则

本项目长期遵守以下原则：

1. **不随意删除原始资料**：原始截图、OCR、历史资料优先保留。
2. **不把待验证内容写死**：不确定内容应明确标记“待验证”。
3. **结论尽量有来源**：重要结论尽量关联截图、OCR、官方内容或专题整理。
4. **新增内容要挂入口**：新增高价值文档后，应同步更新导航、索引或阅读路线。
5. **优先改善可读性**：比起盲目增加数量，更重视分类清晰、标题准确、路径好找。
6. **兼顾用户和 AI 检索**：标题、描述、标签、证据等级应尽量清晰稳定。
7. **历史报告先归档再整理**：不直接删除有价值的历史维护记录。
8. **普通用户入口优先清晰**：导航页应避免让用户直接陷入历史报告或维护细节。

---

## 部署说明

当前文档站适合部署到 Cloudflare Pages、GitHub Pages、Netlify 或其他静态站点托管平台。

Cloudflare Pages 推荐配置：

```txt
构建命令：
pnpm install --frozen-lockfile && pnpm run docs:build

输出目录：
docs/.vitepress/dist

Node.js 版本：
20 或更高
```

本地预验证：

```bash
pnpm run docs:deploy
```

推送到 GitHub 后，Cloudflare Pages 会根据仓库更新自动部署线上站点。

---

## 发布版本建议

发布新版本时，建议按下面顺序检查：

1. 本地预览主要页面。
2. 运行 frontmatter 检查。
3. 运行 UI 检查。
4. 必要时运行完整构建。
5. 推送到 GitHub。
6. 等待 Cloudflare Pages 自动部署。
7. 打开线上网站确认首页、搜索、导航是否正常。
8. 发布 GitHub Release。

推荐提交信息格式：

```txt
优化：首页结构与资料库入口
新增：按问题查资料导航页
新增：资料证据等级说明
修复：处理文档链接与导航异常
整理：清理冗余文档并归档历史报告
优化：提升文档站浏览性能与滚动流畅度
```

---

## 搜索引擎与 AI 检索

本项目会持续优化搜索引擎和 AI 检索友好度：

- 使用清晰的标题和 description。
- 保持文档分类、标签、状态和证据等级稳定。
- 保留 `robots.txt`、`sitemap.xml` 和 `llms.txt`。
- 尽量减少无效链接、空链接和重复内容。
- 将历史归档、自动目录、审计报告等低价值页面排除出本地搜索索引。
- 优先让普通用户入口、学习路线和核心专题被搜索到。

---

## 使用场景

本项目适合用于：

- 学习创游世界基础操作和脚本系统
- 查找创游世界项目设计资料
- 研究变量、广播、UI、组件和系统机制
- 整理 OCR 资料和截图证据链
- 构建创游世界相关 AI 知识库
- 作为 RAG 检索语料或问答参考资料
- 长期维护中文游戏创作资料库

---

## 联系方式

- 作者：[@Azek431](https://github.com/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](./LICENSE)。

---

## Star 支持

如果这个资料库对你有帮助，欢迎点一个 Star 支持一下。

也欢迎反馈错误、补充资料、参与整理，让创游世界相关资料变得更系统、更清晰、更容易被找到。