修复：文档格式

TeamFlos · Oct 20, 2024 · c37eff4 · c37eff4
1 parent 44e2b31
commit c37eff4
Show file tree

Hide file tree

Showing 6 changed files with 66 additions and 60 deletions.
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -18,6 +18,11 @@
       - [普通事件](chart-standard/chart-format/rpe/event.md)
       - [特殊事件](chart-standard/chart-format/rpe/extendEvent.md)
       - [扩展特性](chart-standard/chart-format/rpe/extend.md)
+    - [Official](chart-standard/chart-format/phi/index.md)
+      - [谱面根目录](chart-standard/chart-format/phi/root.md)
+      - [音符](chart-standard/chart-format/phi/note.md)
+      - [事件](chart-standard/chart-format/phi/event.md)
+      - [判定线](chart-standard/chart-format/phi/judgeLine.md)
 
   - [音乐文件格式](chart-standard/music.md)
 

diff --git a/src/chart-standard/chart-format/phi/event.md b/src/chart-standard/chart-format/phi/event.md
@@ -4,63 +4,63 @@
 
 ## speedEvent
 
-|字段名|类型|描述|单位|
-|:-:|:-:|:-:|:-:|
-|startTime|float|事件的开始时间|`1.875 / bpm`|
-|endTime|float|事件的结束时间|`1.875 / bpm`|
-|value|float|事件的值|高度单位|
-|floorPosition|float|速度事件开始时判定线共计以流过的速度  (仅方便计算, 高版本不存在)|高度单位|
+|      字段名      |  类型   |                 描述                  |      单位       |
+|:-------------:|:-----:|:-----------------------------------:|:-------------:|
+|   startTime   | float |               事件的开始时间               | `1.875 / bpm` |
+|    endTime    | float |               事件的结束时间               | `1.875 / bpm` |
+|     value     | float |                事件的值                 |     高度单位      |
+| floorPosition | float | 速度事件开始时判定线共计以流过的速度  (仅方便计算, 高版本不存在) |     高度单位      |
 
 ## judgeLineMoveEvent
 
-|字段名|类型|描述|单位|
-|:-:|:-:|:-:|:-:|
-|startTime|float|事件的开始时间|`1.875 / bpm`|
-|endTime|float|事件的结束时间|`1.875 / bpm`|
+|    字段名    |  类型   |   描述    |      单位       |
+|:---------:|:-----:|:-------:|:-------------:|
+| startTime | float | 事件的开始时间 | `1.875 / bpm` |
+|  endTime  | float | 事件的结束时间 | `1.875 / bpm` |
 
-- formatVersion为1
+- `formatVersion` 为 `1`
 
-  |字段名|类型|描述|单位|
-  |:-:|:-:|:-:|:-:|
-  |start|int|事件的开始坐标|-|
-  |end|int|事件的结束坐标|-|
+|  字段名  | 类型  |   描述    | 单位 |
+|:-----:|:---:|:-------:|:--:|
+| start | int | 事件的开始坐标 | -  |
+|  end  | int | 事件的结束坐标 | -  |
 
-  - 坐标计算 (python):
+- 坐标计算 (Python):
     - `x = (v - v % 1000) // 1000`
     - `y = v % 1000`
     - 单位:
-      - `x` `1 / 880` 谱面渲染范围宽度
-      - `y` `1 / 520` 谱面渲染范围高度
-  - 转化为formatVersion为3的坐标 (python):
+        - `x` `1 / 880` 谱面渲染范围宽度
+        - `y` `1 / 520` 谱面渲染范围高度
+- 转化为formatVersion为3的坐标 (python):
     - 原事件以 `e` 表示, 新事件以 `ne` 表示
     - `ne.start = (e.start - e.start % 1000) // 1000`
     - `ne.end = (e.end - e.end % 1000) // 1000`
     - `ne.start2 = e.start % 1000`
     - `ne.end2 = e.end % 1000`
 
-- formatVersion为3
+- `formatVersion` 为 `3`
 
-  |字段名|类型|描述|单位|
-  |:-:|:-:|:-:|:-:|
-  |start|float|事件的开始坐标|谱面渲染范围宽度|
-  |end|float|事件的结束坐标|谱面渲染范围宽度|
-  |start2|float|事件的开始坐标|谱面渲染范围高度|
-  |end2|float|事件的结束坐标|谱面渲染范围高度|
+|  字段名   |  类型   |   描述    |    单位    |
+|:------:|:-----:|:-------:|:--------:|
+| start  | float | 事件的开始坐标 | 谱面渲染范围宽度 |
+|  end   | float | 事件的结束坐标 | 谱面渲染范围宽度 |
+| start2 | float | 事件的开始坐标 | 谱面渲染范围高度 |
+|  end2  | float | 事件的结束坐标 | 谱面渲染范围高度 |
 
 ### judgeLineRotateEvent
 
-|字段名|类型|描述|单位|
-|:-:|:-:|:-:|:-:|
-|startTime|float|事件的开始时间|`1.875 / bpm`|
-|endTime|float|事件的结束时间|`1.875 / bpm`|
-|start|float|事件的开始值|角度|
-|end|float|事件的结束值|角度|
+|    字段名    |  类型   |   描述    |      单位       |
+|:---------:|:-----:|:-------:|:-------------:|
+| startTime | float | 事件的开始时间 | `1.875 / bpm` |
+|  endTime  | float | 事件的结束时间 | `1.875 / bpm` |
+|   start   | float | 事件的开始值  |      角度       |
+|    end    | float | 事件的结束值  |      角度       |
 
 ### judgeLineDisappearEvent
 
-|字段名|类型|描述|单位|
-|:-:|:-:|:-:|:-:|
-|startTime|float|事件的开始时间|`1.875 / bpm`|
-|endTime|float|事件的结束时间|`1.875 / bpm`|
-|start|float|事件的开始值|-|
-|end|float|事件的结束值|-|
+|    字段名    |  类型   |   描述    |      单位       |
+|:---------:|:-----:|:-------:|:-------------:|
+| startTime | float | 事件的开始时间 | `1.875 / bpm` |
+|  endTime  | float | 事件的结束时间 | `1.875 / bpm` |
+|   start   | float | 事件的开始值  |       -       |
+|    end    | float | 事件的结束值  |       -       |
diff --git a/src/chart-standard/chart-format/phi/index.md b/src/chart-standard/chart-format/phi/index.md
@@ -1 +1,2 @@
-# PHI 文档
+# Phigros Official 谱面文档
+
diff --git a/src/chart-standard/chart-format/phi/judgeLine.md b/src/chart-standard/chart-format/phi/judgeLine.md
@@ -2,19 +2,19 @@
 
 每一个judgeLine（判定线）都含有以下字段：
 
-|字段名|类型|描述|
-|:-:|:-:|:-:|
-|bpm|float|该判定线的bpm值|
-|notesAbove|JsonArray|正面下落的音符|
-|notesBelow|JsonArray|反面下落的音符|
-|speedEvents|JsonArray|速度事件|
-|judgeLineMoveEvents|JsonArray|移动事件|
-|judgeLineRotateEvents|JsonArray|旋转事件|
-|judgeLineDisappearEvents|JsonArray|透明度事件|
+|           字段名            |    类型     |    描述     |
+|:------------------------:|:---------:|:---------:|
+|           bpm            |   float   | 该判定线的bpm值 |
+|        notesAbove        | JsonArray |  正面下落的音符  |
+|        notesBelow        | JsonArray |  反面下落的音符  |
+|       speedEvents        | JsonArray |   速度事件    |
+|   judgeLineMoveEvents    | JsonArray |   移动事件    |
+|  judgeLineRotateEvents   | JsonArray |   旋转事件    |
+| judgeLineDisappearEvents | JsonArray |   透明度事件   |
 
 - **注意: 所有事件及Note的有关时间的项, 单位都为 `1.875 / bpm` s**
 - **这里我们定义:**
-  - "宽度单位" 为 `0.05625 * 谱面渲染范围宽度`
-  - "高度单位" 为 `0.6 * 谱面渲染范围高度`
+    - "宽度单位" 为 `0.05625 * 谱面渲染范围宽度`
+    - "高度单位" 为 `0.6 * 谱面渲染范围高度`
 - [事件](./event.md)
 - [Note](./note.md)
diff --git a/src/chart-standard/chart-format/phi/note.md b/src/chart-standard/chart-format/phi/note.md
@@ -2,11 +2,11 @@
 
 note，即音符，是谱面的主要构成之一，每个note都应该含有以下参数：
 
-|字段名|类型|描述|单位|
-|:-:|:-:|:-:|:-:|
-|type|int|note的类型|-|
-|time|float|note的时间|`1.875 / bpm`|
-|holdTime|float|hold的持续时间  (仅hold, 其他为0.0)|`1.875 / bpm`|
-|positionX|float|note的横向坐标|宽度单位|
-|speed|float|对于非hold: note的速度倍率  对于hold: hold的打击时的速度  tip: hold在打击之前的速度倍率恒为1|-|
-|floorPosition|float|note打击时判定线流过的速度 (仅方便计算)|高度单位|
+|      字段名      |  类型   |                               描述                                |      单位       |
+|:-------------:|:-----:|:---------------------------------------------------------------:|:-------------:|
+|     type      |  int  |                             note的类型                             |       -       |
+|     time      | float |                             note的时间                             | `1.875 / bpm` |
+|   holdTime    | float |                   hold的持续时间  (仅hold, 其他为0.0)                    | `1.875 / bpm` |
+|   positionX   | float |                            note的横向坐标                            |     宽度单位      |
+|     speed     | float | 对于非hold: note的速度倍率  对于hold: hold的打击时的速度  tip: hold在打击之前的速度倍率恒为1 |       -       |
+| floorPosition | float |                     note打击时判定线流过的速度 (仅方便计算)                     |     高度单位      |
diff --git a/src/chart-standard/chart-format/phi/root.md b/src/chart-standard/chart-format/phi/root.md
@@ -1,6 +1,6 @@
-# PHI谱面根目录结构
+# Phigros Official谱面根目录结构
 
-- 目前`PHI`谱面的数据计算与渲染已经十分成熟
+- 目前`Phigros Official`谱面的数据计算与渲染已经十分成熟
 
 ## 谱面根目录结构