CK3-history-extractor

A program for generating a wikipedia of your CK3 playthrough. It goes through the lineage of every player in the save file and extracts data about every character, title, religion, culture, etc. it encounters. It even renders cool graphs that depict your history. You can preview how you can expect the result to look like in your browser here

Usage

First you will need to decide what version of the program you want to use. There are three potential versions of the program:

• Release - Every now and then I release a new GitHub release that has compiled binaries attached. You can simply download those binaries and use them. For those unfamiliar with GitHub go here and this is the version you should honestly use.

• Dev - You can also just compile the program from source on your machine ofchoice. Here's the rust installation guide and once you have rust installed this section explains how to compile a rust program. Additionally you can also have a look at how I compile the program in the makefile.

• Legacy - a Python based script developed way back with no support, but you can access it here

After making your choice go find your save file in the format the program accepts.

Obtaining the save file

In order to use any version of the program you are going to need a text based unzipped CK3 save file. You can find your save files in your documents directory in %USERPROFILE%\Documents\Paradox Interactive\Crusader Kings III\save games\. With the current tool version all save files are supported right out of the box.

Running the program

You can run the program from the command line or just by double clicking it. If you ran it with no arguments it will ask you for the path to the file and for the path to the game. Within the console interface the program should automatically pre-enter the save file path and game path. You can modify this pre-entered path of course and on some systems this feature might not function. It is very important that game path provided points to the /game subdirectory in your Crusader Kings III folder. Otherwise you will receive errors when providing the path. For users familiar with console environments here are details on that interface:

./ck3_history_extractor <save file path> <arg1> <arg2> ...

You can use the --help argument to view all the options. Save File paths need to point to a specific files, not your save folder

Mod support

This program should work just fine on modded save files. Some specific aspects may be represented inaccurately to the in game state, but that can be alleviated with providing the tool with the paths to the mods using the include argument. Now naturally very invasive mods allowing for individual country de jure drift, or using weird non standard title naming schemes might break the tool. If that occurs please do let me know and I shall see what I can do.

Load order

Internally all provides paths (those added via include and game-path) are handled in the same way. Iteratively these paths are searched for localization and a valid map definition, with the first path provided being searched almost last. Once a valid map definition is found this definition is used and is expected to be entirely valid. The game path is loaded last.

Output example

You can find output examples in the examples directory. Just unzip the files contained within and witness the glory of my dynasty! Additionally I simply deployed the result to GitHub pages meaning you can preview the result here.

Other similar tools

• CK2-history-extractor is a tool like this for CK2

Problems

If you encounter any problems please do let me know. The best way to do that is by creating a new issue on GitHub, this will let me track them better. This also applies to feature suggestions and general feedback.

Features

• Each in game entity will get it's own HTML page with data and links to other related entities. Characters will link to their Faith, Culture etc...
• Faith and Culture pages will display graphs showing the amount of deaths of their members through time, which allows for rough tracking of trends within your game
• Dynasty pages will display family trees
• Titles will display de facto maps of their extent if applicable and the game path is provided
• A timeline page with a graphic will display the lifespans of empires and notable events like conquests and falls of notable cities
• A timelapse gif will show the de jure growth of the importance of your line

Development status

The tool has been rewritten using Rust. Currently I'm working on new features and bugfixes. Be sure to star this repository or watch it to get regular updates regarding the process. If you want to contribute feel free to do so! Plenty of things to be done, just read this.

License

This work is licensed under the MIT license. The text of the license is fairly self explanatory, you can find it here