安装与启用

CLIFF Localization Suite 是面向 Unreal Engine 5.8 的本地化插件,双模块结构:CliffLocalizationSuite(Runtime,CLIFF 数据模型与解析器)与 CliffLocalizationSuiteEditor(Editor,官方管线集成、导入导出与 AI 翻译)。本文档引导你完成安装、启用与验证。

前置条件

要求
引擎版本Unreal Engine 5.8(EngineAssociation: 5.8
平台Win64 / Mac / Linux(PlatformAllowList
本地化 Target项目中已存在至少一个 Localization Target(Localization Dashboard 中创建)
Python不需要。插件运行时纯 C++,无 Python 依赖
网络(可选)仅在使用 AI 翻译时需要访问 DeepSeek API

NOTE

插件的 Runtime 模块不依赖任何编辑器模块,Game / Shipping 目标可以正常打包;导入、导出与 AI 翻译全部位于 Editor 模块,不会进入运行时包。

安装插件

从 Fab 商城安装

  1. 在 Fab 商城搜索 “CLIFF Localization Suite”,或打开产品页
  2. 将插件添加到 Epic Games 账户库
  3. 通过 Epic Games Launcher 安装到目标引擎版本

从源码安装

  1. CliffLocalizationSuite 插件文件夹放入项目的 Plugins/ 目录(目录不存在则手动创建)

  2. 启动项目,UE 检测到新插件后选择编译插件

    UE5 检测到新插件后弹出“是否重新编译”提示,选择“是”

  3. 编译完成后打开 编辑 > 插件,搜索 “CLIFF Localization Suite”

  4. 勾选插件并重启编辑器

IMPORTANT

发布包采用源码交付:只包含 .upluginSource/Content/,不含 Binaries/Intermediate/.pdb。首次启用时需要本机编译一次(需要可用的 C++ 工具链)。

启用插件

  1. 打开 编辑 > 插件

  2. 搜索 “CLIFF Localization Suite”

    插件管理器中搜索 “CLIFF Localization Suite”,勾选插件行

  3. 勾选 CLIFF Localization Suite 复选框

  4. 点击右下角 立即重启 重启编辑器

NOTE

插件启用时会把自己注册为官方 LocalizationService 模块化功能(modular feature)并选中为当前 Provider,因此 Localization Dashboard 打开时工具栏就已经带上 CLIFF 按钮,无需手动在下拉框中切换。启动日志会打印 provider registered and selected as modular feature 'LocalizationService'

选择 Provider

如果 Dashboard 工具栏没有出现 CLIFF 按钮:

  1. 打开 工具 > 本地化 Dashboard(Tools → Localization Dashboard)
  2. Localization Service Provider 下拉框中选择 CLIFF Localization Suite
  3. 重新打开 Dashboard,Target 与 TargetSet 工具栏的右侧会出现 CLIFF 导入 / CLIFF 导出 / AI 翻译 三个按钮

TIP

Provider 选择在 Dashboard 构建工具栏时被快照。若在 Dashboard 已打开的情况下切换 Provider,请关闭并重新打开 Dashboard。

显示插件内容

插件的本地化数据随包分发(7 个 Localization Target × 15 种语言)。若要查看这些资产:

  1. 内容浏览器左上角 设置 菜单
  2. 勾选 显示插件内容
  3. Plugins/CliffLocalizationSuite/Content/Localization/ 下即可看到各 Target 的 manifest / archive 与编译产物

项目设置

安装后打开 编辑 > 项目设置 > 插件 > CLIFF Localization Suite,四个分类:

分类内容
IdentityCLIFF Namespace:CLIFF 文件头部使用的项目标识(小写 kebab-case)
Semantic MappingClan to NamespaceNamespace to TypeNamespace to Emotion 三张映射表
Workflow导入 / 导出文件对话框的默认目录
AI TranslationDeepSeek API Key、模型、提示词、批量与重试参数

全部字段说明见 设置参考

C++ 模块依赖

在项目或自有插件的 Build.cs 中引用 CLIFF 类型时:

// Runtime:CLIFF 数据模型、解析器、校验器、序列化器、语义映射与设置
PublicDependencyModuleNames.AddRange(new string[]
{
    "Core", "CoreUObject", "Engine", "DeveloperSettings",
    "CliffLocalizationSuite"
});
// Editor:导入器、导出器、AI 翻译、GatherText 命令let
PrivateDependencyModuleNames.AddRange(new string[]
{
    "CliffLocalizationSuiteEditor"
});

NOTE

运行时模块名称为 "CliffLocalizationSuite"CliffLocalizationSuiteEditor 模块为 Type: Editor,只在编辑器目标中构建,Game / Server 目标不会包含它。

验证安装

1. 控制台命令自检

在编辑器控制台(~)中执行:

CliffLocalizationSuite.Hello

输出日志 CliffLocalizationSuite.Hello: parser, importer and exporter are active (M5 integration). 说明模块已加载。

2. Dashboard 按钮检查

打开 工具 > 本地化 Dashboard,选中一个 Target,确认工具栏出现 CLIFF 导入 / CLIFF 导出 / AI 翻译 三个按钮(Tooltip 分别为「从 CLIFF 文件导入翻译到当前本地化 Target。」「把当前本地化 Target 导出为 CLIFF 文件。」「导出 CLIFF,使用 DeepSeek 翻译缺失 target,再自动导入。」)。

3. 往返冒烟测试

  1. CLIFF 导出 → 选择输出目录 → 确认每个 culture 目录下生成了 .cliff 与根目录的 .cliffmap.json
  2. CLIFF 导入 → 选择刚才导出的 .cliff → 确认官方进度窗口完成并可复制日志
  3. 打开 窗口 > 本地化 > 翻译编辑器,确认条目与译文正常

完整流程见 Dashboard 工作流

TIP

若编译报错,请确认引擎版本为 UE 5.8、项目已生成 C++ 工程文件,并检查 Build.cs 的模块依赖拼写(CliffLocalizationSuite / CliffLocalizationSuiteEditor)。