Modding

From CK3 Wiki
Jump to navigation Jump to search
CK3 Modding #1 -Brief introduction to modding. Roll1D2 Games guide on useful tools and how-to mod beginner's guide.

Modding, or creating mods, is the act of modifying the assets or behavior of the game either for personal use, or to release publicly to other players, for instance via Paradox Mods or the Steam Workshop.

As with all Paradox games, Crusader Kings III is moddable to a great extent. Motivations of modders may vary widely; better translation to native language, more events or decisions, better map, major overhaul, cheating, etc.

This guide is intended to lower the entry barriers to the world of Crusader Kings III modding. However, there is still a learning curve to it, and it cannot replace the need to read some working vanilla code and do lots of trial and error experimentation.

Important: the majority of mods will change the checksum, not allowing the player to get achievements. See checksum_manifest.txt in the game folder for the list of checksummed folders and files. The only safe mods are the ones that replace textures, shaders, fonts or music.

Tips & guidelines[edit]

  • Create a mod for your modifications: use a personal mod even for minor changes, and never directly modify the game files in the CK3 game folder as they may be overwritten without warning.
  • Use a good text editor to edit files and search through folders. The following are free:
    • Visual Studio Code. Has a fan-made CWTools extension with Paradox syntax highlighting, validation and tooltips for triggers and effects. To install it, go to Extensions on the left panel of VS and search for CWTools. (Note: validation rules are incomplete and will show many false errors in gui and localization files)
    • Notepad++. Choose Perl as your language, as it will provide good highlighting and allow to fold blocks of code and comments. To set it as default, go to Settings, Styler Configurator, find Perl in the list on the left and add "gui txt" (without quotes) to the "User ext." field at the bottom.
    • Atom. Doesn't include UTF-8-BOM encoding needed for localization files. Otherwise is very customizable. Choose Perl 6 as your language for better results. To set it as default, go to File, Config, find "core:" and add below it: "customFileTypes: "source.perl6": [ "txt" "gui"]", like in this example.
    • Sublime Text. There is an extension for it released by the developers of Imperator which could be used with CK3: Sublime Tools. It adds colored highlighting for effects and triggers. If you want to toggle comments in Sublime, you also need to add this file to the same "User" folder.
  • Always check the error.log file for execution errors. ...\Documents\Paradox Interactive\Crusader Kings III\logs
  • The log folder also contains lists of effects, triggers and scopes. Use "script_docs" and "DumpDataTypes" console commands in the game to generate them.
  • Start the game with -debug_mode -develop launch options to use the console and "reload gui", "reload gfx" commands.
    • On Steam: right-click the game on Steam -> Properties -> Set Launch Options -> add -debug_mode -develop
    • Windows: Create a shortcut for the .exe file -> right-click it -> Properties -> add -debug_mode -develop at the end of the Target field
  • The directory for the CK3 folder on Linux is ~/.local/share/Paradox Interactive/Crusader Kings III
  • Clearly communicate whether your mod is ironman-friendly to players.
  • Remove your local mod when you subscribe to the Steam version, otherwise it may not work in the game.
  • Backup your work. Either manually or with a source control system like Git. Also consider using GitHub for team collaboration.
  • Use a proper merge tool (like WinMerge) to merge between folders and update modified files for a new patch.
  • If you're replacing text across dozens or hundreds lines of code, you may want to use regular expressions. They are available in all of the text editors above. Learning resources: RegexOne, RegExr.

Localization Files[edit]

  • *.yml files in the localization folder must be saved with UTF-8 + BOM encoding to be read properly by the game.
  • filenames need to be saved in the form as *l_<language>.yml for the game to read the file correctly. For example council_l_english.yml.

Creating a mod[edit]

  1. Open the Crusader Kings III launcher.
  2. Navigate to the "Mods" section.
  3. Press "Mod Tools", "Create a Mod"
  4. Enter your preferred mod name, version, directory and any tags.
  5. When done, press "Create Mod" at the bottom.
  6. Once created, the relevant mod files will appear in the game's mod folder (Default on Windows: C:\Users\%USERPROFILE%\Documents\Paradox Interactive\Crusader Kings III\mod)

Uploading/updating a mod[edit]

Upload your mod again to update it.

  1. Open the launcher.
  2. Navigate to the "Mods" section.
  3. Press "Mod Tools", choose your mod from the dropdown menu.
  4. Choose what platform to upload it to.
  5. Enter any description. (If updating, make sure the launcher copied the most recent one from the site.)
  6. Add a thumbnail
    • For the Steam Workshop, put thumbnail.png in the mod folder. Use 1:1 ratio, 1MB max. The biggest thumbnail the Workshop displays is around 600x600 pixels.
    • For Paradox Mods, drag the thumbnail to the field below the description. Suggested minimum size is 900x500, png or jpg, 1MB max.
  7. Press "Upload".
    • On Steam, the mod will be uploaded in private mode and appear in your Steam Profile -> Workshop Items. Open it and change visibility on the side bar to Public to actually publish.
    • On Paradox Mods the mod will be published after the verification process. You may need to edit your description, as the site usually removes line breaks and BBCode formatting.

Save game editing[edit]

Save files are located in Documents\Paradox Interactive\Crusader Kings III\save games

It is not possible to edit an ironman save!

First start the game in the debug mode and save.

  • On Steam: right-click the game on Steam -> Properties -> Set Launch Options -> add -debug_mode
  • Windows: Create a shortcut for the .exe file -> right-click it -> Properties -> add -debug_mode at the end of the Target field

PC:

  1. Find the save file in the save games folder.
  2. Right-click the save file and extract it like an archive with 7-Zip or WinRar.
  3. Rename the extracted 'gamestate' file to something with a .ck3 extension.
  4. Right-click it and open with your text editor (Windows Notepad is not recommended as the save files are very big).
  5. Edit the file and save it.
  6. Load it in the game.

Autosaves can be edited directly without extracting the gamestate.

Mac:

  1. Open Terminal
  2. Ensure that the directory is set to the correct folder
  3. Type in "unzip FileName.ck3"
  4. Rename the extracted 'gamestate' file to something with a .ck3 extension
  5. Edit this plain-text save
  6. Load it directly in the game (no need to re-compress)
OS Save type Location
Windows Local C:\Users\%USERPROFILE%\Documents\Paradox Interactive\Crusader Kings III\save games
Windows Steam Cloud C:\Program Files (x86)\Steam\userdata\####\1158310\remote\save games
Mac Local $HOME/Documents/Paradox Interactive/Crusader Kings III/save games
Linux Local $HOME/.local/share/Paradox Interactive/Crusader Kings III/save games

Extracting files From Microsoft Store version[edit]

If you want to read the files using the Microsoft Store version, you can use a program called UWPDumper to extract the files.

  1. Download the latest x64 binary of UWPDumper
  2. Enable Developer Mode (Windows Settings -> Update and Security -> For Developers -> Developer Mode).
  3. Run CK3.
  4. Run UWPInjector.exe from the program you just downloaded.
  5. Enter the number next to ck3.exe : ParadoxInteractive.ProjectTitus_zfnrdv2de78ny as the processID.
  6. Check where it is going to store the files (probably somewhere like C:\Users\%USERPROFILE%\AppData\Local\Packages\ParadoxInteractive.ProjectTitus_zfnrdv2de78ny\TempState\DUMP
  7. Wait for the program to finish.

The files should then be present in the directory specified earlier. If you want to edit the files, create a mod and copy the desired files there.

Tools & utilities[edit]

External links[edit]


Characters CharactersAttributesTraitsResourcesLifestyleDynastyCultureInnovationsModifiers
Realm & Governance VassalsCouncilCourtSchemesGovernmentLawsDecisionsTitlesBaronyCounty
Warfare WarfareCasus belliAllianceArmyHired forces
Faith ReligionFaithDoctrinesTenets
Meta ModdingPatchesDownloadable contentDeveloper diariesAchievementsJargon