docs: 补充文件夹命名规范 (#1111)
This commit is contained in:
32
README.md
32
README.md
@@ -22,7 +22,7 @@
|
||||
#### 文件命名规范
|
||||
确保脚本文件在同一目录下按预期顺序排列,并一目了然地传达关键信息。地图追踪脚本命名需包含以下核心信息:
|
||||
```
|
||||
编号-材料名称-区域(跨区域材料填写)-二级子区域-数量
|
||||
编号-材料名称-区域(跨区域材料填写)-二级区域(可选)-二级子区域-数量
|
||||
```
|
||||
- 编号
|
||||
- 两位数,如果单个资源脚本数量超过 `100` 可以考虑使用三位数编号或者使用字母加数字编号,如 A01
|
||||
@@ -33,6 +33,7 @@
|
||||
- 采集物(使用游戏内官方名称命名,如 `慕风蘑菇`,`劫波莲`,不应当使用 `绫华突破材料`等不清晰的名称命名)
|
||||
- 掉落物(因掉落物名称与掉落物等级有关,因此不使用掉落物本身命名,而是使用怪物名称命名)
|
||||
- 区域(指 `蒙德` `璃月` `稻妻` `须弥` `枫丹` `纳塔` `至冬`,仅当材料跨区域需标注)
|
||||
- 二级区域(如 `珉林`,根据实际需求标注)
|
||||
- 二级子区域(细分地点,如 `绝云间`)
|
||||
- 预期采集的数量
|
||||
示例:
|
||||
@@ -42,14 +43,14 @@
|
||||
```
|
||||
脚本名称仅限上述规定的编号、材料名称、区域、二级子区域,不应包含额外的描述或标点符号。如:
|
||||
```
|
||||
01-水晶块-璃月-快速路径-绝云间-6个
|
||||
❌01-水晶块-璃月-快速路径-绝云间-6个
|
||||
```
|
||||
其他注意事项
|
||||
- 脚本文件名应当和 `json` 文件中的 `name` 字段相同。
|
||||
#### 文件夹命名规范
|
||||
|
||||
目的:对脚本按材料分类管理,便于版本控制与团队协作。目录结构应当遵循以下原则:
|
||||
- 根据脚本种类选择恰当的一级分类,目前共有六个分类 `锄地专区`、`地方特产`、'敌人与魔物`、`矿物`、`其他`。
|
||||
- 根据脚本种类选择恰当的一级分类,目前共有六个分类 `锄地专区`、`地方特产`、`敌人与魔物`、`矿物`、`其他`。
|
||||
- 一级目录:以材料名称命名,须与文件命名中的材料名称一致。
|
||||
- 二级子目录(可选):可根据项目或作者划分,如有必要。
|
||||
示例目录结构如下:
|
||||
@@ -58,19 +59,38 @@ repo/pathing/矿物
|
||||
├─ 水晶块/
|
||||
│ ├─ 01-水晶块-璃月-绝云间-6个
|
||||
│ └─ 02-水晶块-璃月-荻花洲-8个
|
||||
└─ 风车菊/
|
||||
└─ 01-风车菊-蒙德-清泉镇-15个
|
||||
└─ 星银矿石/
|
||||
└─ 01-星银矿石-覆雪之路-7个
|
||||
```
|
||||
如果脚本和原来的地图追踪脚本存在冲突 按照以下原则处理:
|
||||
- 修复或补充:直接提交到原材料目录。
|
||||
- 路线冲突:新建同名目录并添加作者标识:
|
||||
1. 将旧脚本目录重命名为 `AA@旧作者名`
|
||||
2. 新脚本放入 `AA@你的名字`
|
||||
3. 例:原 `repo/pathing/AA` 重命名为 `repo/pathing/AA@oldauthor` 新目录 `repo/pathing/AA@yourname`
|
||||
3. 例:原 `repo/pathing/AA` 重命名为 `AA@oldauthor` 新目录 `AA@yourname`
|
||||
4. 示例目录结构如下:
|
||||
```
|
||||
repo/pathing/.../
|
||||
└── AA/
|
||||
├── AA@旧作者名
|
||||
└── AA@你的名字
|
||||
```
|
||||
|
||||
- 不同采集方式|效率:新建目录添加标识及作者标识:
|
||||
1. 判断旧脚本目录的采集方式,将旧脚本目录重命名为 `采集方式@旧作者名`
|
||||
2. 新脚本放入 `采集方式@你的名字`
|
||||
3. 示例目录结构如下:
|
||||
```
|
||||
repo/pathing/.../
|
||||
└── AA/
|
||||
├── 无草神@广告位招租
|
||||
├── 有草神@广告位招租
|
||||
└── 效率路线@广告位招租
|
||||
```
|
||||
其他注意事项
|
||||
- 目录名仅限材料官方名称,不添加版本号或其他标识。
|
||||
- 作者标识仅在冲突时追加,格式为“@作者名”,紧随原目录名。
|
||||
- 相同二级子区域有多条路径时,推荐采用 `编号-材料名称-二级区域-二级子区域及方位-数量` 进行命名。
|
||||
|
||||
### 其他
|
||||
因早期对脚本管理较为宽松,因此仓库有部分脚本并不符合命名规范,欢迎通过 PR 规范这些名称。
|
||||
|
||||
Reference in New Issue
Block a user