CK3 Save is a library to ergonomically work with Crusader Kings III (CK3) saves (ironman + regular).
```rust use ck3save::{ models::{Gamestate, HeaderBorrowed}, Ck3File, Encoding, EnvTokens, };
let data = std::fs::read("assets/saves/JarlIvaroftheIsles8670101.ck3")?; let file = Ck3File::fromslice(&data)?; assert_eq!(file.encoding(), Encoding::TextZip);
let meta = file.parse_metadata()?; let header: HeaderBorrowed = meta.deserializer().build(&EnvTokens)?;
let mut zipsink = Vec::new(); let parsedfile = file.parse(&mut zipsink)?; let save: Gamestate = parsedfile.deserializer().build(&EnvTokens)?; asserteq!(save.metadata.version, String::from("1.0.2")); asserteq!(header.metadata.version, String::from("1.0.2")); ```
By default, ironman saves will not be decoded properly.
To enable support, one must supply an environment variable
(CK3_IRONMAN_TOKENS) that points to a newline delimited
text file of token descriptions. For instance:
ignore
0xffff my_test_token
0xeeee my_test_token2
In order to comply with legal restrictions, I cannot share the list of tokens. I am also restricted from divulging how the list of tokens can be derived.