RhythMC 谱师文档结构说明

本文档说明 RhythMC 谱师文档的组织结构和使用指南。

文档结构

docs/charter/
├── README.md                    # 主索引页面
├── DOCUMENTATION_SUMMARY.md     # 本文档
├── song-format.md              # 歌曲格式（YAML + JSON）
├── arena-format.md             # 地图格式（YAML）
├── animation.md                # 轨道动画系统
├── effects.md                  # 效果系统索引（已拆分）
├── note-types/                 # 音符类型目录
│   ├── note-types.md          # 音符类型总览
│   ├── tap.md                 # TAP 音符 - 点击音符
│   ├── look.md                # LOOK 音符 - 观察音符
│   ├── hold.md                # HOLD 音符 - 长押音符
│   └── dodge.md               # DODGE 音符 - 躲避音符
└── effects/                    # 效果系统目录
    ├── effects.md             # 效果系统总览
    ├── hologram.md            # HOLOGRAM - 全息图效果
    ├── remove-hologram.md     # REMOVE_HOLOGRAM - 移除全息图
    ├── title.md               # TITLE - 标题显示效果
    ├── firework.md            # FIREWORK - 烟花效果
    ├── time.md                # TIME - 时间设置效果
    ├── effect.md              # EFFECT - 药水效果
    ├── clear-effect.md        # CLEAR_EFFECT - 清除药水效果
    ├── weather.md             # WEATHER - 天气效果
    ├── arena.md               # ARENA - 地图切换效果
    ├── text-display.md        # TEXT_DISPLAY - 文本显示效果
    ├── text-display-effect.md # TEXT_DISPLAY_EFFECT - 文本显示效果变换
    ├── text-display-sync-track.md    # TEXT_DISPLAY_SYNC_TRACK - 轨道同步
    ├── text-display-desync-track.md  # TEXT_DISPLAY_DESYNC_TRACK - 停止同步
    ├── text-display-remove.md        # TEXT_DISPLAY_REMOVE - 移除文本显示
    ├── hide-notes.md          # HIDE_NOTES - 隐藏音符效果
    ├── glow-color.md          # GLOW_COLOR - 发光颜色效果
    └── message.md             # MESSAGE - 消息效果

文档类型

1. 格式文档

• song-format.md: 歌曲文件的 YAML 和 JSON 格式
• arena-format.md: 地图文件的 YAML 格式
• animation.md: 轨道动画的 NumEvent 系统

2. 音符类型文档

每个音符类型文档包含：

• 技术规格（类型值、ZNear/ZFar）
• JSON 格式和字段说明
• 判定系统和容差值
• 使用示例和注意事项

3. 效果系统文档

每个效果文档包含：

• 技术规格（效果类型、实现类）
• JSON 格式和字段说明
• 使用示例
• 注意事项

使用指南

创建音符

1. 查看 note-types/note-types.md 了解音符类型
2. 选择具体音符类型文档（如 tap.md）
3. 按照 JSON 格式编写音符数据

添加效果

1. 查看 effects/effects.md 了解效果类型
2. 选择具体效果文档（如 hologram.md）
3. 按照 JSON 格式编写效果数据

编写歌曲

1. 查看 song-format.md 了解歌曲结构
2. 创建 manifest.yml 文件
3. 创建 .rmcc 谱面文件

创建地图

1. 查看 arena-format.md 了解地图结构
2. 创建 metadata.yml 文件
3. 使用 WorldEdit 创建 .schem 文件

技术规格说明

音符通用字段

字段	类型	说明
noteType	int	音符类型 (0-3)
beat	double	拍数位置
pos	double[3]	[X, Y, Z] 坐标
scale	float[3]	[X, Y, Z] 缩放
rotation	float[3]	[X, Y, Z] 旋转
holdGroup	int	长押组 ID

效果通用字段

字段	类型	说明
eventType	string	效果类型
beat	double	触发拍数
properties	object	效果参数

判定窗口

判定类型	时间窗口
PERFECT	±110ms
FAST_GREAT	110ms ~ 220ms
LATE_GREAT	-220ms ~ -110ms
MISS	>220ms 或 <-220ms

容差值

音符类型	容差值
TAP	0.15
LOOK	0.15
HOLD	0.15
DODGE	0.1

相关链接

• GitHub 仓库
• 问题反馈