创游世界文档格式示例
一句话摘要
本文档展示创游世界知识库的常用 Markdown 格式写法，帮助文档贡献者快速上手统一规范的文档格式。
适合谁阅读
- 准备为创游世界知识库贡献文档的新手
- 需要参考文档格式规范的维护者
- 希望了解知识库格式约定的所有用户
你将学到什么
- 标准 frontmatter 元数据的写法
- 代码块、表格、自定义容器的用法
- 内部链接和图片引用的规范
- 文档结构的最佳实践
1. 前置元数据（Frontmatter）
每篇文档开头必须有完整的 frontmatter 元数据块：
yaml
---
date: 2026-05-16
title: 页面标题
description: 用一句话说明这篇文档解决什么问题。
editor: Azek431
status: 已整理
difficulty: 入门
evidence: 资料整理
updated: 2026-05-16
category: 分类名称
version: v0.2.x
tags:
- 创游世界
- 相关标签
---元数据字段说明
| 字段 | 必填 | 说明 |
|---|---|---|
title | 是 | 文档标题 |
description | 是 | 一句话描述，用于 SEO |
editor | 是 | 文档编辑者 |
status | 是 | 文档状态：草稿/整理中/已结构化/待验证/已复核/持续维护 |
difficulty | 是 | 难度：入门/进阶/高级/研究向 |
evidence | 是 | 证据等级：E1直接证据/E2 OCR/E3归纳/E4社区经验/资料整理/待验证 |
updated | 是 | 最后更新日期 |
category | 是 | 所属分类 |
version | 是 | 适用版本 |
tags | 是 | 标签数组 |
2. 文档标准结构
一篇完整的知识库文档建议包含以下章节：
markdown
# 标题
## 一句话摘要
用 1-3 句话说明本文讲什么、解决什么问题。
## 适合谁阅读
说明目标读者群体。
## 你将学到什么
用列表说明读者读完能获得什么。
---
## 核心内容
正文内容...
---
## 相关页面
列出相关文档链接。
## 待验证问题
列出不能确定的内容。
## 后续优化方向
说明这篇文档以后还能补什么。3. 代码块
3.1 单行代码
使用反引号包裹单行代码：设置自身属性1为1
3.2 多行代码
javascript
// 创游世界脚本示例：检测碰撞并发送广播
当 物体 被 碰撞时
如果 自身属性["状态"] == "可拾取" 则
触发/发送广播 "道具被拾取" 并携带值 [当前物体.名称]
销毁自身
结束
结束3.3 积木块代码
使用 cysj 语言标注创游世界专用代码：
txt
当 开始时
设置局部变量[金币数]为 0
新建局部变量[临时计算]为 1 + 2
结束
当 执行"增加金币"时
设置局部变量[金币数]为 局部变量[金币数] + 参数[数量]
触发/发送广播 "金币更新" 并携带值 [局部变量[金币数]]
结束4. 表格
4.1 组件分类表
| 分类 | 组件名称 | 主要功能 |
|---|---|---|
| 通用 | 物理组件 | 赋予移动、碰撞能力 |
| 通用 | 角色组件 | 赋予角色控制能力 |
| 战斗 | 生命组件 | 赋予血量、伤害检测 |
| 战斗 | 武器槽组件 | 赋予装备武器能力 |
| 装置 | 可互动物体 | 赋予交互触发能力 |
| 装置 | 物体UI | 允许显示物体绑定的界面 |
4.2 变量作用域表
| 作用域 | 生命周期 | 存储位置 | 适用场景 |
|---|---|---|---|
| 局部变量 | 当前脚本执行完 | 脚本内部 | 临时计算、中间值 |
| 自身属性 | 物体存活期 | 物体数据层 | 单物体状态 |
| 地图属性 | 地图切换前 | 地图数据层 | 多物体共享 |
| 系统属性 | 全局持久 | 云端 | 玩家进度、存档 |
5. 自定义容器
信息提示
这是信息提示框，用于补充说明重要概念。
组件决定物体「能做什么」，脚本决定物体「何时做」。
提示
这是提示框，用于分享实用技巧。
广播机制适合跨物体通信，但不适合高频同步场景。
警告
这是警告框，用于提醒容易踩的坑。
修改素材后，地图上已有的物体不会自动更新！
危险
这是危险警告，用于标记高风险操作。
循环脚本中必须添加等待语句，否则会导致游戏卡死。
详细内容
这是可折叠的详细内容区域。
适用于放长代码、长表格或补充说明。
6. 引用块
核心概念：素材是模板，物体是实例。理解这个区别是学习创游世界的基础。
广播机制：广播是一种「发消息给多个对象」的事件通知机制。发广播的对象不需要知道谁在监听。
7. 列表
7.1 无序列表
- 脚本编辑器：用积木块编写行为逻辑
- 组件面板：给物体添加功能组件
- 素材库：管理游戏资源
- 地图编辑区：摆放物体、构建场景
7.2 有序列表（学习路径）
- 理解素材、物体、组件、脚本四个核心概念
- 学习变量作用域和数据分层
- 掌握广播机制和事件驱动
- 实践项目结构和系统设计
7.3 嵌套列表
- 战斗系统设计
- 生命组件
- 血量上限
- 受伤逻辑
- 武器槽组件
- 武器切换
- 攻击检测
- 伤害计算
- 攻击力属性
- 防御力减伤
- 生命组件
8. 内部链接
站内链接使用相对路径或 / 开头的绝对路径：
markdown
- [新手阅读路线](/总索引与导航/新手阅读路线)
- [脚本界面与积木知识索引](/脚本系统/脚本界面与积木知识索引)
- [广播机制深度解析](/教程资料/专题研究/广播机制深度解析)效果：
9. 图片引用
图片应放在 docs/public/images/ 目录下：
markdown
10. 水平分隔线
使用 --- 创建章节分隔：
markdown
---
## 下一章节
内容...11. 注意事项
- Frontmatter 必需：每篇文档开头应有完整的 frontmatter
- 标题层级：H1 只出现一次，H2/H3 要语义清晰
- 链接路径：站内链接使用相对路径或
/开头的绝对路径 - 代码块标注：积木块脚本使用
cysj语言标注 - 表格对齐：使用
---:右对齐，:---左对齐，:---:居中 - 一句话摘要：在文档开头用 1-3 句话概括本文核心
- 适用对象：说明本文适合哪些读者
- SEO 优化：description 要清晰准确，tags 要具体不泛
12. 相关页面
- 页面模板 - 标准文档模板
- 知识条目统一元数据规范 - frontmatter 完整规范
- 社区贡献与维护指南 - 贡献流程说明
- 文档状态分级规则 - 文档状态说明
待验证问题
[待验证]不同代码块语言的语法高亮支持情况
后续优化方向
- [ ] 补充更多实际文档示例
- [ ] 添加图示说明格式效果
- [ ] 补充常见格式错误示例