Running the Localization Pipeline

You can run Unreal's Localization pipeline as a UAT commandlet or directly from Visual Studio.

Configuring the Pipeline

  • In Unreal's menus, open Tools → Localization Dashboard
  • Click Check Out File to check out the DefaultEditor.ini file where the configuration is written to.
  • We recommend unchecking all Gather Text options except for Gather from Packages.
  • In the Gather Text menu, add directory entries for:
    • The directory containing your Consequence Database Uasset (you should already have created this default database for use with your pipeline)
    • The directory pointed to by your Consequence String Tables Folder setting in the Plugins → Consequence Editor Settings settings
  • Ensure that Skip Gather Cache is CHECKED so that Consequence entries are not missed.
  • Ensure that all your target languages are present in the Languages list.

Testing the pipeline from the Localization Dashboard

  • Click the Gather Text button
    • Wait for the OK button to appear in the pop-up dialogue. You should see the .archive files for your languages, and some .ini files checked out.
  • Click the Import Text button and wait for it to complete, click OK.
    • (when running manually, a directory browser popup will appear and you will have to click "Select Folder" inside the Content\Localization\Game directory to proceed with this step)
  • Click the Export Text button and wait for it to complete, click OK.
    • (when running manually, a directory browser popup will appear and you will have to click "Select Folder" inside the Content\Localization\Game directory to proceed with this step)
  • Click the Compile Text button and wait for it to complete, click OK.

Once the steps above are completed, all the relevant files should be checked out in Perforce and updated. You can run "Revert Unchanged Files" from Perforce on that changelist to remove files that were checked out but ultimately did not need to be updated.

Open the .po files for each language in a text editor to confirm what data has been gathered. If Consequence lines are missing, make sure that you added the correct directory in the "Gather Text" menu inside "Gather from Packages", and that you checked the Skip Gather Cache option.

Running the pipeline from Visual Studio

To run it from Visual Studio, use the following format, substituting the name of your project for [ProjectName]:

[ProjectName] -run=GatherText -fastexit -Config="Config/Localization/Game_Gather.ini;Config/Localization/Game_Import.ini;
Config/Localization/Game_Export.ini;Config/Localization/Game_Compile.ini"

In order to run the command with Perforce source control integration (i.e. to check out relevant files as they are changed)

Running from a batch file or the command line

  • Open a new Command Line and go to your Engine's executable file directory: cd "[Path To UnrealEngine]\Binaries\[Platform]"
    • For example, for most users it would be something like: cd "C:\UnrealInstallLocation\Engine\Binaries\Win64"
  • Run UnrealEditor "[path to your .uproject file]" -run=GatherText -Config="Config/Localization/Game_Gather.ini;Config/Localization/Game_Import.ini;Config/Localization/Game_Export.ini;Config/Localization/Game_Compile.ini" -EnableSCC -sccprovider=Perforce -p4port=[Perforce Port] -p4user=[Perforce User] -p4client=[Perforce Workspace]
    • Again, as a representative example, the full command might be something like: UnrealEditor "C:\UnrealInstallLocation\MyShooterGame\MyShooterGame.uproject" -run=GatherText -Config="Config/Localization/Game_Gather.ini;Config/Localization/Game_Import.ini;Config/Localization/Game_Export.ini;Config/Localization/Game_Compile.ini" -EnableSCC -sccprovider=Perforce -p4port=1666 -p4user=BobTheUser -p4client=BobsWorkspaceName
  • If all goes well, after a few seconds a new command line window will open, the various steps will run, and the output will end with:
GatherText completed with exit code 0
LogInit: Display: Finished.
LogInit: Display:
Execution of commandlet too: x seconds

If you check your Perforce, you will discover that your Perforce user has now submitted the new localized files.

  • If all does not go well, or you want to check the output of the command, you can open your log at C:\[YourUnrealLocation]\[ProjectName]\Saved\Logs\[ProjectName].log to find the output of the command.