FairyGUI 多语言工具说明文档

工具用途

本工具用于 FairyGUI 多语言文件的格式转换，支持以下功能：

• CSV 转 XML：将包含多语言文本的 CSV 文件转换为 FairyGUI 支持的 XML 格式文件
• XML 转 CSV：将 FairyGUI 的 XML 格式多语言文件转换为 CSV 格式，方便编辑和管理

安装依赖

在使用本工具之前，需要先安装依赖：

cd fairygui-i18n
npm install

用法

1. CSV 转 XML

将 CSV 文件转换为 XML 文件：

# 使用默认配置
npm run csv2xml

# 指定自定义语言列表
npm run csv2xml -- -l zh_cn,en_us,jp_jp,kr_kr

# 指定自定义文件路径
npm run csv2xml -- -c ../../UIProject/ui_zh_cn.csv -x ../../UIProject/

# 同时指定语言列表和文件路径
npm run csv2xml -- -l zh_cn,en_us -c ../../UIProject/ui_zh_cn.csv -x ../../UIProject/

2. XML 转 CSV

将 XML 文件转换为 CSV 文件：

# 使用默认配置
npm run xml2csv

# 指定自定义语言列表
npm run xml2csv -- -l zh_cn,en_us,jp_jp,kr_kr

# 指定自定义文件路径
npm run xml2csv -- -c ../../UIProject/ui_zh_cn.csv -x ../../UIProject/

# 同时指定语言列表和文件路径
npm run xml2csv -- -l zh_cn,en_us -c ../../UIProject/ui_zh_cn.csv -x ../../UIProject/

命令行参数

| 参数 | 说明 | 默认值 | |------|------|--------| | -l, --languages | 要处理的语言列表，用逗号分隔 | en_us,zh_cn | | -c, --csvFile | CSV 文件路径 | ../../UIProject/ui_zh_cn.csv | | -x, --xmlDir | XML 目录路径 | ../../UIProject/ |

输入输出文件

CSV 文件

• 输入/输出路径：../../UIProject/ui_zh_cn.csv
• 格式：第一行为表头，包含 key, desc 以及各语言代码列，最后一列为 tag

XML 文件

• 输出/输入目录：../../UIProject/
• 文件名格式：ui_<语言代码>.xml（例如：ui_zh_cn.xml）

用法示例

示例 1：使用默认配置

# 转换 CSV 到 XML
npm run csv2xml

# 转换 XML 到 CSV
npm run xml2csv

示例 2：指定自定义语言列表

# 转换 CSV 到 XML，处理中文、英文、日文和韩文
npm run csv2xml -- -l zh_cn,en_us,jp_jp,kr_kr

# 转换 XML 到 CSV，处理中文、英文、日文和韩文
npm run xml2csv -- -l zh_cn,en_us,jp_jp,kr_kr

示例 3：指定自定义文件路径

# 转换 CSV 到 XML，使用自定义文件路径
npm run csv2xml -- -c ../../UIProject/ui_zh_cn.csv -x ../../UIProject/

# 转换 XML 到 CSV，使用自定义文件路径
npm run xml2csv -- -c ../../UIProject/ui_zh_cn.csv -x ../../UIProject/

示例 4：同时指定语言列表和文件路径

# 转换 CSV 到 XML，指定语言列表和文件路径
npm run csv2xml -- -l zh_cn,en_us -c ../../UIProject/ui_zh_cn.csv -x ../../UIProject/

# 转换 XML 到 CSV，指定语言列表和文件路径
npm run xml2csv -- -l zh_cn,en_us -c ../../UIProject/ui_zh_cn.csv -x ../../UIProject/

注意事项

1. 文件路径：工具默认使用相对路径 ../../UIProject/ 作为输入输出目录，请确保该目录存在且包含正确的文件。

2. 语言代码：语言代码必须与 CSV 文件中的列名和 XML 文件名对应，例如 zh_cn、en_us 等。

3. CSV 格式：CSV 文件必须包含 key、desc 列和各语言代码列，最后一列为 tag。

4. XML 格式：XML 文件必须符合 FairyGUI 的多语言文件格式，包含 <resources> 根节点和多个 <string> 子节点。

5. 编码：所有文件均使用 UTF-8 编码。

批处理文件

为了方便使用，项目根目录提供了两个批处理文件：

1. 收集FGUI多语言表.bat：执行 XML 转 CSV 操作，使用默认文件路径
2. 导出FGUI多语言表.bat：执行 CSV 转 XML 操作，使用默认文件路径和语言列表

这些批处理文件已经配置为使用默认参数，可以直接双击运行。如果需要自定义参数，可以编辑批处理文件修改相应的变量值。