Releases: TCA166/CK3-history-extractor
2.3.2
2.3 fix 2
This release brings bug fixes and quality of life changes.
A reworked CLI should make interactions easier and more human friendly error messages should help users when they encounter problems.
Full Changelog: v2.3.1...v2.3.2
v2.3.1
2.3 fix 1
This release brings quality of life improvements, bugfixes and other general improvements.
Most notably the console interface now requires less prompts and should auto suggest the game path.
That feature especially requires YOUR feedback so please do let me know if it works well.
Additionally a whole lot of code under the hood has been rewritten and brought up to common rust standards.
Full Changelog: v2.3.0...v2.3.1
v2.3.0
Roads to Power Update
This release brings minor feature improvements as well as compatibility fixes.
Surprisingly enough Paradox changed the save file format and new save files won't work with 2.3.
Features
I have tidied up how graphics look like, meaning now they should look a lot less janky and be a lot more informative.
Additionally now dynasty mottos will be extracted and cultures and faiths will have their own maps.
So in general nothing major just polish.
As always in case of problems please do let me know.
What's next
Unfortunately creating a chronicle functionality seems to be unfeasable as of right now.
Data scarcity is a major issue, and the idea with an LLM is a bust because it would be too difficult for the average user to utilize.
So while in the future I might come back to this idea, as of right now I will focus on implementing visualizations for the new features and general maintenance of the tool.
Full Changelog: v2.2.0...v2.3.0
v2.2.0
Artifact update
This release brings quality of life improvements, new graphic rendering capabilities and handling of artifacts.
Now instead of a crude console interface, a much superior one is available, meaning less reliance on the command line arguments.
Additionally progress bars will visualize what is going on.
A rework of the game data import system now allows modded save files to be better rendered than before.
Also character inventories are now visualized with new graphics like the dynastic holdings map, royal lineage graph and the genetic similarity heatmap allowing you to better visualize your playthrough.
What's next
I have been planning to add a chronicle functionality for a while now.
Naturally I find the concept of reimplementing the ck2 chronicle system to be pointless (and impossible thanks to data scarcity) so it's hard to say how that would look like.
Also a general rework of html templates (though graphic design definetly isn't my strong suit) and continuous work on optimizations is warranted.
Full Changelog: v2.1.0...v2.2.0
v2.1.0
Timelapse update
Apart from minor fixes and improvements the main feature of this release is the introduction of timelapses.
Now based on fragmentary data from the save file your playthrough progress will be visualised in the form of a gif, assuming you provide the game path of course.
It is in no way perfect, but lack of data keeps my hands tied in that regard.
Full Changelog: v2.0.1...v2.1.0
v2.0.1
Fix 1
Implemented some minor bug fixes and quality of life improvement based on immediate feedback to 2.0 and suggestions from users.
Full Changelog: v2.0.0...v2.0.1
v2.0.0
Rust rewrite release
I have rewritten the entirety of the original script in Rust, bringing speed, stability and accuracy improvements alongside brand new features!
I will list here all the main changes, but if you aren't interested in that just download the executable version attached to this release that applies to your system and go on your way. The guide on how to use the tool is in the README.
New features
Apart from having ported the entirety of the old feature set, this rewrite brings with it the addition of graphs to the output. Now most pages have their own graphic that aims to help you visualise the game world better, Titles have rendered maps of the de facto extent of each title, characters and faiths display graphs of deaths through time, which allows us to visualise the rise and decline of a culture or faith and the savefile itself has a timeline page with a cool graphic that visualises the lifespans of empires and notable events like holy wars and great conquests. While I might not be able to render portaits I am damn well making sure there are things to look at.
Speed improvements
The old Python script was painfully slow. Now thanks to a better parsing approach and a transition to a faster language the program works surprisingly fast. The old Python script took about 5 mins to go through a file and generate all the html. The Rust version takes about 30 seconds to do the same, but with more characters and graphics in each page. Staggering improvement to say the least. Disabling graphic rendering brings that time down to just 8 seconds on my machine.
Future
I will continue working on this I think. Still plenty of things to improve, fix and implement. I am sure pdx will add new features worth visualising and I still got some ideas for cool graphs.
Full Changelog: v2-pre...v2.0.0
V2-pre
This is the early version of the rust port of the old Python script.
It works, and is blazing fast compared to the Python version, probably has fewer bugs too!
It's just that it still has a few bugs that need to be squashed, mostly with localization and game data retrieval.
Also haven't done a general review meaning code quality speed and maintainability can still be improved.
But already this is better than the Python version so feel free to use.
Download the exe if you are using Windows.
Read the README on usage notes.
Legacy Python Version
Old version in Python
This is the legacy version of the tool written in Python in mid 2023, so before the release of "Legacy of Persia". Doesn't support many of the game's features is fairly slow and has plenty of bugs. Currently I'm rewriting the tool in Rust which will be faster, more reliable and support more features but if you want to use this version feel free to do so. Read the README though to get info on installation and requirements alongside configuration notes.
How to install
- Download the .zip of this release using the button below
- Unzip the code
- Ensure you have python 3 installed
- Ensure your ck3 savefile is unencrypted (ironman save files are encrypted)
- If your savegame is compressed (by default it is):
- Unzip your ck3 file as if it was an archive and get the gamestate file inside
- Add ".ck3" to your gamestate file - this is your actual savefile
- Prepare your save file in the same directory as CK3_history_extractor.py
- Make sure the template html files are in the same directory as CK3_history_extractor.py
- Make sure the lookup file is in the same directory as CK3_history_extractor.py
- Run CK3_history_extractor.py in the src directory
- Follow the prompts
I have encountered an issue, help!
Try looking in the README file for solutions, if that doesn't work then tough luck.
You can try patching the issue yourself and making a pull request, but I will not be developing this version any further