28 releases
0.4.3 | Oct 24, 2022 |
---|---|
0.3.2 | Sep 12, 2022 |
0.3.1 | Jul 8, 2022 |
0.2.13 | Mar 20, 2022 |
0.1.4 | Oct 29, 2020 |
#1043 in Game dev
Used in ck3json
51KB
1K
SLoC
CK3 Save
CK3 Save is a library to ergonomically work with Crusader Kings III (CK3) saves (ironman + regular).
use ck3save::{
models::{Gamestate, HeaderBorrowed},
Ck3File, Encoding, EnvTokens,
};
let data = std::fs::read("assets/saves/Jarl_Ivar_of_the_Isles_867_01_01.ck3")?;
let file = Ck3File::from_slice(&data)?;
assert_eq!(file.encoding(), Encoding::TextZip);
let meta = file.parse_metadata()?;
let header: HeaderBorrowed = meta.deserializer().build(&EnvTokens)?;
let mut zip_sink = Vec::new();
let parsed_file = file.parse(&mut zip_sink)?;
let save: Gamestate = parsed_file.deserializer().build(&EnvTokens)?;
assert_eq!(save.meta_data.version, String::from("1.0.2"));
assert_eq!(header.meta_data.version, String::from("1.0.2"));
Ironman
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:
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.
Dependencies
~2–3MB
~65K SLoC