UE5在本地化上的PortableObjectImport.ini文件源码解读分析

1. 概述

本文档是对PortableObjectImport.ini配置文件的详细解析，它是Unreal Engine 5（UE5）本地化工作流的一部分。此文件控制着本地化数据的导入过程，使得开发者能够为多种语言环境提供游戏内容。
 

PortableObjectImport.ini文件

[CommonSettings]
bImportLoc=true                                 ; 指示是否应导入本地化数据，此处设置为真以启用导入。
NativeCulture=en                                ; 项目的原生语言文化，这里设置为英语。
CulturesToGenerate=en                           ; 列出需要生成本地化数据的语言文化，包括英语。
CulturesToGenerate=es                           ; 包括西班牙语。
CulturesToGenerate=ja                           ; 包括日语。
CulturesToGenerate=ko                           ; 包括韩语。
CulturesToGenerate=pt-BR                        ; 包括巴西葡萄牙语。
CulturesToGenerate=zh-Hans                      ; 包括简体中文。

[GatherTextStep0]
CommandletClass=InternationalizationExport      ; 指定用于国际化导出的命令类。
SourcePath=Content/Localization/Engine          ; 定义引擎本地化内容的源路径。
DestinationPath=Content/Localization/Engine     ; 定义引擎本地化内容的目标路径。
ManifestName=Engine.manifest                    ; 引擎本地化内容的清单文件名。
ArchiveName=Engine.archive                      ; 引擎本地化内容的存档文件名。
PortableObjectName=Engine.po                    ; 引擎本地化内容的便携式对象文件名。

[GatherTextStep1]
CommandletClass=InternationalizationExport      ; 同上，适用于编辑器本地化内容。
SourcePath=Content/Localization/Editor          ; 编辑器本地化内容的源路径。
DestinationPath=Content/Localization/Editor     ; 编辑器本地化内容的目标路径。
ManifestName=Editor.manifest                    ; 编辑器本地化内容的清单文件名。
ArchiveName=Editor.archive                      ; 编辑器本地化内容的存档文件名。
PortableObjectName=Editor.po                    ; 编辑器本地化内容的便携式对象文件名。

[GatherTextStep2]
CommandletClass=InternationalizationExport      ; 同上，适用于工具提示本地化内容。
SourcePath=Content/Localization/ToolTips        ; 工具提示本地化内容的源路径。
DestinationPath=Content/Localization/ToolTips   ; 工具提示本地化内容的目标路径。
ManifestName=ToolTips.manifest                  ; 工具提示本地化内容的清单文件名。
ArchiveName=ToolTips.archive                    ; 工具提示本地化内容的存档文件名。
PortableObjectName=ToolTips.po                  ; 工具提示本地化内容的便携式对象文件名。

[GatherTextStep3]
CommandletClass=InternationalizationExport      ; 同上，适用于属性名本地化内容。
SourcePath=Content/Localization/PropertyNames   ; 属性名本地化内容的源路径。
DestinationPath=Content/Localization/PropertyNames ; 属性名本地化内容的目标路径。
ManifestName=PropertyNames.manifest             ; 属性名本地化内容的清单文件名。
ArchiveName=PropertyNames.archive               ; 属性名本地化内容的存档文件名。
PortableObjectName=PropertyNames.po             ; 属性名本地化内容的便携式对象文件名。

[GatherTextStep4]
CommandletClass=InternationalizationExport      ; 同上，适用于编辑器教程本地化内容。
SourcePath=Content/Localization/EditorTutorials ; 编辑器教程本地化内容的源路径。
DestinationPath=Content/Localization/EditorTutorials ; 编辑器教程本地化内容的目标路径。
ManifestName=EditorTutorials.manifest           ; 编辑器教程本地化内容的清单文件名。
ArchiveName=EditorTutorials.archive             ; 编辑器教程本地化内容的存档文件名。
PortableObjectName=EditorTutorials.po           ; 编辑器教程本地化内容的便携式对象文件名。

2. 配置解读

[CommonSettings]

• bImportLoc=true: 此标志为真，表示本地化数据将被导入到引擎中。
• NativeCulture=en: 设定了项目的原生语言文化为英语。
• CulturesToGenerate: 这些行列出了需要导入本地化数据的语言文化代码。

[GatherTextStep0] 到 [GatherTextStep4]

这些节描述了本地化数据导入流程中的连续步骤。每一步使用InternationalizationExport命令行工具来处理不同的资源类型：

• SourcePath: 指向包含待导入本地化内容的源目录。
• DestinationPath: 指向本地化内容将被导入的目的目录，通常与SourcePath相同。
• ManifestName: 清单文件名，包含了所有需要本地化的文本的列表。
• ArchiveName: 存档文件名，包含了翻译后的文本。
• PortableObjectName: 指向.po文件，这是一种常用的本地化文件格式，包含了源文本及其对应的翻译。

在这个过程中，CommandletClass始终使用InternationalizationExport，这暗示了配置文件可能命名不准确，实际上是用于导出而不是导入，或者这个命令类在内部处理了导入和导出。

3. 重要的架构和难点

• 可扩展性：配置文件支持通过添加更多的CulturesToGenerate行来扩展更多的语言。
• 模块化：每个步骤对应于处理特定的资源类型，从而使流程易于理解和维护。
• 准确性：必须确保所有文件路径和名称正确无误，以避免导入过程中的任何错误。

4. 结论

UE5的PortableObjectImport.ini文件是国际化工作流的关键组成部分，它确保游戏内容可以在多种语言环境下准确展示。通过理解和遵循这些配置，开发者可以确保为全球玩家提供无缝和沉浸式的游戏体验。