Spelling checker for Crusader Kings 3 localization files.
It also works for Imperator: Rome, Stellaris, Hearts of Iron 4, and Europa Universalis 4.
Localization files for CK3 (Crusader Kings 3) contain the text presented to the user for all the UI elements, in-game events and decisions, etc.
This text often needs to be adjusted depending on the game situation, such as who is involved in an event and which of the involved characters is the player.
Because of that need, the localization texts often contain small blocks of code, such as [Character.GetCulture.GetName], or formatting directives such as $VALUE|=+0$.
ck3spell is a spelling checker that is optimized for these localization files. It skips the bits of code and other non-text content, and applies its spelling check only to the words that will be shown to the user.
- Colors the localization strings to make the user-visible parts easy to recognize
- Detects the language and supports all languages supported by Paradox except Korean and Chinese
- Can add words to a permanent local dictionary
- Understands the custom word endings used in french, german, and spanish localizations (CK3 only)
ck3spell uses hunspell dictionaries but not the hunspell library.
On Debian and Ubuntu, you should install one or more hunspell dictionary packages depending on which languages you want to check.
The dictionaries are also bundled in the .tar.gz release archive, so you only need to install them if you prefer the system ones.
- English:
hunspell-en-us - German:
hunspell-de-de - Spanish:
hunspell-es - French:
hunspell-fr - Russian:
hunspell-ru - Portuguese:
hunspell-pt-br - Polish:
hunspell-pl
sudo apt install hunspell-en-us hunspell-de-de hunspell-es hunspell-fr hunspell-ru hunspell-pt-br hunspell-pl
All the necessary dictionaries are bundled in the .zip release archive. As long as you keep them together with the ck3spell.exe file, ck3spell will find them and use them.
ck3spell uses the GTK-3 library on Linux.
On Debian and Ubuntu, you should install the libgtk-3-dev package before compiling ck3spell.
sudo apt install libgtk-3-dev
From the Releases section, download the latest release for your platform.
Either the linux .tar.gz or the windows .zip.
Unpack it, then go to your mod's directory and do something like
Linux:
cd your/mods/directory path/to/ck3spell localization/english/*.yml
Windows, from the command line:
CD /D your\mods\directory path\to\ck3spell localization\english\**\*.yml
where the path/to/ is to where you unpacked ck3spell, and "english" is whichever language's files you want to spellcheck.
(The \**\*.yml pattern after the language selects all localization files, even deep in subdirectories. Linux users can do that too, after setting shopt -s globstar (in bash). You can also be more selective and list individual files to check.)
ck3spell will show you the files one by one, and each time you click "Save and close" it will show you the next one. You can also use the "Prev" and "Next" buttons at the top to cycle through the files.
Jump to the misspelled words by clicking the "Previous" and "Next" buttons in the central button row. For each word, you can either "Accept word" to accept it as a correctly spelled word, or pick one of the offered corrections from the window below, or "Edit line" to go in and edit that whole line. ck3spell always edits one line at a time, because CK3 localization files are based on one line per localization.
Normally "Accept word" only accepts a word for the current spellchecking session. If you want it to remember words long term, you can use the --local-dict option, like this:
Linux:
path/to/ck3spell --local-dict ck3spell.list localization/english/*.yml
Windows:
path\to\ck3spell --local-dict ck3spell.list localization\english\**\*.yml
The name ck3spell.list can be any filename you like.
- Support Korean and Chinese.
- Support installation and dictionary bundling on Mac.