ck3-Translator

This Project allows the user to automatically translate ck3 (Crusader Kings 3) localisation files to other languages supported by the game and the translator API.

ATTENTION! This project is pretty new and there might be some cornercases I haven't adressed yet If you find a Bug please let me know and provide the files to reproduce the Error

Authors

• @CyberNord
• @Martin220799 (Powershell Controls)

Installation

Requirements

Before Starting make sure the following libraries are installed.

• Python 3.10 (or higher)
• googletrans 4.0.0rc1

It is important to use the googletrans version 4.0.0rc1 (or higher) older versions will cause the the Program to throw an error.

First Steps

Download the project folder from github and unpack it in a Location of your desire. Start a command prompt (e.g. PowerShell) in the path where the main.py is located. The default setting is translating from english to german and it will look like that.

  python main.py D:\the\path\to\english\loc\folder

Usage

Below you can see the general Syntax

python main.py [-h] [-l1 L1] [-l2 L2] [-trans TRANS] path

The following parts are mandatory

• python main.py    call of the programm
• path                       path to the folder to be translated

Optional information

• [-h]                      no function for now
• [-l1 L1]                given input language (default = en)
• [-l2 L2]                desired output language (default = de)
• [-trans TRANS]  (default = 1) If this value is set to 0 there will be no translation. The Programm wil only convert the files to the disired output language so that it is supported by the game (e.g. results in english text in german localisation)

Supported languages

The list is limited by the possible localisations supported in CK3.

• 'en' english
• 'de' german
• 'fr' french
• 'es' spanish
• 'ru' russian
• 'zh-cn' simplified chinese
• 'ko' korean

More examples

this will translate from english (default) to french

python main.py -l2 fr D:\the\path\to\english\loc\folder

this will translate from french to german (default)

python main.py -l1 fr D:\the\path\to\english\loc\folder

this will just alter the first line and filename so that the localisation is detected by the game

python main.py -trans 0 D:\the\path\to\english\loc\folder

FAQ

Why is this taking so long?

A 2 second timeout was implemented after each translation cycle. This had to be done because the current API does not currently accept a mass request and, in extreme cases, completely blocks further requests.

Why are some lines not translated at all?

The API has problems translating certain sentences or very long strings correctly. In order to avoid complete crap, the default language is retained in such cases. Especially translations from English into Spanish are very prone to this.

Will this translator work for other iterations of the pdx genere?

Some tests were made with the "Stellaris" localization files, which turned out to be satisfactory on the whole. I strongly assume that most of the titles are compatible since the syntax is similar or even identical. So yes, you can probably use this translator for "Stellaris" or other titles from the developer Paradox.

What kind of Syntax is currently supported in the translation files?

• Square Bracket Content: Text enclosed in square brackets, including the brackets themselves. For example, [example] would be filtered.
• Dollar Sign Enclosed Text: Text enclosed between dollar signs ($), including the dollar signs themselves. For example, $example$ would be filtered.
• Hashtag Enclosed Text: Text enclosed between hashtags (#), including the hashtags themselves. For example, #example# would be filtered.
• Newline Sequence: The newline character \n, which represents a line break in a text.
• @-Prefixed Text: Text that starts with @ and ends with an exclamation mark (!). For example, @example! would be filtered.