94 lines
1.8 KiB
Markdown
94 lines
1.8 KiB
Markdown
# 预设文件维护说明
|
|
|
|
## 文件位置
|
|
|
|
预设配置放在:
|
|
|
|
```text
|
|
public/Preset/
|
|
```
|
|
|
|
预设索引:
|
|
|
|
```text
|
|
public/Preset/index.json
|
|
```
|
|
|
|
## 新增预设
|
|
|
|
1. 把新的预设配置放入 `public/Preset/`。
|
|
2. 重新启动开发服务或执行构建,索引会自动更新。
|
|
3. 部署时一起上传 `index.json`、预设文件和 `dist/`。
|
|
|
|
自动生成示例:
|
|
|
|
```json
|
|
{
|
|
"file": "8.烟花爆炸.json",
|
|
"name": {
|
|
"zh-CN": "8.烟花爆炸",
|
|
"zh-TW": "8.烟花爆炸",
|
|
"en": "8.烟花爆炸",
|
|
"ja": "8.烟花爆炸",
|
|
"ko": "8.烟花爆炸",
|
|
"fr": "8.烟花爆炸",
|
|
"de": "8.烟花爆炸",
|
|
"pt-BR": "8.烟花爆炸",
|
|
"es": "8.烟花爆炸"
|
|
}
|
|
}
|
|
```
|
|
|
|
## 规则
|
|
|
|
- `file` 是实际预设配置文件名,必须与磁盘文件完全一致。
|
|
- `name` 是下拉框显示名称,不参与文件加载。
|
|
- `name` 可以省略;省略时直接显示去掉 `.json` 后缀的文件名。
|
|
- `name` 也兼容旧版字符串格式和多语言对象格式。
|
|
- 文件名建议使用稳定、简洁的名称,可使用 ASCII。
|
|
- 当前生成器会把所有语言字段都填成文件名本身。
|
|
- 自动生成工具可以只输出文件记录:
|
|
|
|
```json
|
|
{
|
|
"file": "8.fireworks.json"
|
|
}
|
|
```
|
|
|
|
界面会显示为:
|
|
|
|
```text
|
|
8.fireworks
|
|
```
|
|
|
|
- 旧版字符串格式仍然兼容:
|
|
|
|
```json
|
|
{
|
|
"file": "8.fireworks.json",
|
|
"name": "8.烟花爆炸"
|
|
}
|
|
```
|
|
|
|
字符串格式会在所有语言中显示同一个名称。
|
|
|
|
## 回退顺序
|
|
|
|
当某种语言的名称缺失时,界面依次使用:
|
|
|
|
```text
|
|
当前语言 → English → 简体中文 → 文件名
|
|
```
|
|
|
|
验证命令:
|
|
|
|
```bash
|
|
npm run test:i18n
|
|
```
|
|
|
|
该命令会检查:
|
|
|
|
- 每个预设文件是否存在;
|
|
- 多语言名称字段格式是否有效;
|
|
- 语言包键和插值占位符是否一致。
|