halbu 0.3.0

Diablo II save file parsing library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264

use std::ops::Range;

use crate::character::codec::CharacterCodec;
use crate::character::common::{
    read_fixed_array, read_name_string, read_range, read_u32_le_at, read_u8_at, write_exact_bytes,
    write_name_string, write_u32_le_at, write_u8_at,
};
use crate::character::mercenary::Mercenary;
use crate::character::{parse_last_act, write_last_act, Character, Status};
use crate::Class;
use crate::ExpansionType;
use crate::ParseHardError;

pub struct CharacterCodecV105;

pub const OFFSET_WEAPON_SET: usize = 0;
pub const OFFSET_STATUS: usize = 4;
pub const OFFSET_PROGRESSION: usize = 5;
pub const OFFSET_CLASS: usize = 8;
pub const OFFSET_RESERVED_VERSION_MARKER_ONE: usize = 9;
pub const OFFSET_RESERVED_VERSION_MARKER_TWO: usize = 10;
pub const OFFSET_LEVEL: usize = 11;
pub const OFFSET_LAST_PLAYED: usize = 16;
pub const RANGE_RESERVED_CHECKSUM_MASK: Range<usize> = 20..24;
pub const RANGE_ASSIGNED_SKILLS: Range<usize> = 24..88;
pub const OFFSET_LEFT_MOUSE_SKILL: usize = 88;
pub const OFFSET_RIGHT_MOUSE_SKILL: usize = 92;
pub const OFFSET_LEFT_MOUSE_SWITCH_SKILL: usize = 96;
pub const OFFSET_RIGHT_MOUSE_SWITCH_SKILL: usize = 100;
pub const RANGE_MENU_APPEARANCE: Range<usize> = 104..136;
pub const RANGE_DIFFICULTY: Range<usize> = 136..139;
pub const OFFSET_MAP_SEED: usize = 139;
pub const RANGE_MERCENARY: Range<usize> = 145..159;
// Legacy unknown region shifted earlier in v105.
pub const RANGE_UNKNOWN_REGION_ONE: Range<usize> = 159..187;
// New 48-byte region inserted in v105 before resurrected menu appearance.
pub const RANGE_UNKNOWN_REGION_TWO: Range<usize> = 187..235;
// Observed mode-like byte in v105 saves.
// 1 = classic, 2 = expansion, 3 = RotW.
pub const OFFSET_MODE_MARKER: usize = 232;
pub const MODE_CLASSIC: u8 = 1;
pub const MODE_EXPANSION: u8 = 2;
pub const MODE_ROTW: u8 = 3;
const V105_CHARACTER_LENGTH: usize = 387;
// Resurrected menu appearance moved to this range in v105.
pub const RANGE_RESURRECTED_MENU_APPEARANCE: Range<usize> = 235..283;
pub const RANGE_NAME: Range<usize> = 283..331;
// Legacy trailing unknown region shifted in v105.
pub const RANGE_UNKNOWN_REGION_THREE: Range<usize> = 331..351;
// New trailing bytes appended in v105.
pub const RANGE_UNKNOWN_REGION_FOUR: Range<usize> = 351..387;

const ASSIGNED_SKILL_SLOT_COUNT: usize = 16;

pub fn mode_marker(character: &Character) -> Option<u8> {
    if character.raw_section.len() != V105_CHARACTER_LENGTH {
        return None;
    }

    character.raw_section.get(OFFSET_MODE_MARKER).copied()
}

pub fn expansion_type_from_mode_marker(mode_marker: u8) -> Option<ExpansionType> {
    match mode_marker {
        MODE_CLASSIC => Some(ExpansionType::Classic),
        MODE_EXPANSION => Some(ExpansionType::Expansion),
        MODE_ROTW => Some(ExpansionType::RotW),
        _ => None,
    }
}

pub fn expansion_type(character: &Character) -> Option<ExpansionType> {
    mode_marker(character).and_then(expansion_type_from_mode_marker)
}

pub(crate) fn mode_marker_from_expansion_type(expansion_type: ExpansionType) -> u8 {
    match expansion_type {
        ExpansionType::Classic => MODE_CLASSIC,
        ExpansionType::Expansion => MODE_EXPANSION,
        ExpansionType::RotW => MODE_ROTW,
    }
}

pub(crate) fn set_expansion_type(character: &mut Character, expansion_type: ExpansionType) {
    if character.raw_section.len() != V105_CHARACTER_LENGTH {
        character.raw_section = vec![0u8; V105_CHARACTER_LENGTH];
    }

    character.raw_section[OFFSET_MODE_MARKER] = mode_marker_from_expansion_type(expansion_type);
}

pub(crate) fn mode_marker_for_encode(character: &Character) -> u8 {
    mode_marker(character).unwrap_or(MODE_ROTW)
}

impl CharacterCodec for CharacterCodecV105 {
    const CHARACTER_LENGTH: usize = V105_CHARACTER_LENGTH;

    fn decode(character_section_bytes: &[u8]) -> Result<Character, ParseHardError> {
        if character_section_bytes.len() < Self::CHARACTER_LENGTH {
            return Err(ParseHardError {
                message: format!(
                    "Character section is truncated for v105: expected {} bytes, found {}.",
                    Self::CHARACTER_LENGTH,
                    character_section_bytes.len()
                ),
            });
        }

        let mut character = Character {
            raw_section: character_section_bytes[..Self::CHARACTER_LENGTH].to_vec(),
            ..Character::default()
        };
        let raw_bytes = &character.raw_section;

        character.weapon_switch = read_u32_le_at(raw_bytes, OFFSET_WEAPON_SET, "weapon_set")? != 0;
        character.status = Status::from(read_u8_at(raw_bytes, OFFSET_STATUS, "status")?);
        character.progression = read_u8_at(raw_bytes, OFFSET_PROGRESSION, "progression")?;
        character.class = Class::from_id(read_u8_at(raw_bytes, OFFSET_CLASS, "class")?);
        character.level = read_u8_at(raw_bytes, OFFSET_LEVEL, "level")?;
        character.last_played = read_u32_le_at(raw_bytes, OFFSET_LAST_PLAYED, "last_played")?;

        for assigned_skill_index in 0..ASSIGNED_SKILL_SLOT_COUNT {
            let skill_offset = RANGE_ASSIGNED_SKILLS.start + (assigned_skill_index * 4);
            character.assigned_skills[assigned_skill_index] =
                read_u32_le_at(raw_bytes, skill_offset, "assigned_skill")?;
        }

        character.left_mouse_skill =
            read_u32_le_at(raw_bytes, OFFSET_LEFT_MOUSE_SKILL, "left_mouse_skill")?;
        character.right_mouse_skill =
            read_u32_le_at(raw_bytes, OFFSET_RIGHT_MOUSE_SKILL, "right_mouse_skill")?;
        character.left_mouse_switch_skill =
            read_u32_le_at(raw_bytes, OFFSET_LEFT_MOUSE_SWITCH_SKILL, "left_mouse_switch_skill")?;
        character.right_mouse_switch_skill =
            read_u32_le_at(raw_bytes, OFFSET_RIGHT_MOUSE_SWITCH_SKILL, "right_mouse_switch_skill")?;

        character.menu_appearance =
            read_fixed_array(raw_bytes, RANGE_MENU_APPEARANCE.clone(), "menu_appearance")?;
        let difficulty_bytes = read_fixed_array(raw_bytes, RANGE_DIFFICULTY.clone(), "difficulty")?;
        (character.difficulty, character.act) = parse_last_act(&difficulty_bytes)?;
        character.map_seed = read_u32_le_at(raw_bytes, OFFSET_MAP_SEED, "map_seed")?;
        character.mercenary =
            Mercenary::parse(read_range(raw_bytes, RANGE_MERCENARY.clone(), "mercenary")?)?;
        character.resurrected_menu_appearance = read_fixed_array(
            raw_bytes,
            RANGE_RESURRECTED_MENU_APPEARANCE.clone(),
            "resurrected_menu_appearance",
        )?;
        character.name = read_name_string(raw_bytes, RANGE_NAME.clone(), "name")?;

        Ok(character)
    }

    fn encode(character: &Character) -> Result<Vec<u8>, ParseHardError> {
        let mut encoded_bytes = if character.raw_section.len() == Self::CHARACTER_LENGTH {
            character.raw_section.clone()
        } else {
            vec![0u8; Self::CHARACTER_LENGTH]
        };

        write_u32_le_at(
            &mut encoded_bytes,
            OFFSET_WEAPON_SET,
            u32::from(character.weapon_switch),
            "weapon_set",
        )?;
        write_u8_at(&mut encoded_bytes, OFFSET_STATUS, u8::from(character.status), "status")?;
        write_u8_at(&mut encoded_bytes, OFFSET_PROGRESSION, character.progression, "progression")?;
        write_u8_at(&mut encoded_bytes, OFFSET_CLASS, u8::from(character.class), "class")?;
        write_u8_at(&mut encoded_bytes, OFFSET_LEVEL, character.level, "level")?;
        write_u32_le_at(
            &mut encoded_bytes,
            OFFSET_LAST_PLAYED,
            character.last_played,
            "last_played",
        )?;

        for assigned_skill_index in 0..ASSIGNED_SKILL_SLOT_COUNT {
            let skill_offset = RANGE_ASSIGNED_SKILLS.start + (assigned_skill_index * 4);
            write_u32_le_at(
                &mut encoded_bytes,
                skill_offset,
                character.assigned_skills[assigned_skill_index],
                "assigned_skill",
            )?;
        }

        write_u32_le_at(
            &mut encoded_bytes,
            OFFSET_LEFT_MOUSE_SKILL,
            character.left_mouse_skill,
            "left_mouse_skill",
        )?;
        write_u32_le_at(
            &mut encoded_bytes,
            OFFSET_RIGHT_MOUSE_SKILL,
            character.right_mouse_skill,
            "right_mouse_skill",
        )?;
        write_u32_le_at(
            &mut encoded_bytes,
            OFFSET_LEFT_MOUSE_SWITCH_SKILL,
            character.left_mouse_switch_skill,
            "left_mouse_switch_skill",
        )?;
        write_u32_le_at(
            &mut encoded_bytes,
            OFFSET_RIGHT_MOUSE_SWITCH_SKILL,
            character.right_mouse_switch_skill,
            "right_mouse_switch_skill",
        )?;

        write_exact_bytes(
            &mut encoded_bytes,
            RANGE_MENU_APPEARANCE.clone(),
            &character.menu_appearance,
            "menu_appearance",
        )?;
        write_exact_bytes(
            &mut encoded_bytes,
            RANGE_DIFFICULTY.clone(),
            &write_last_act(character.difficulty, character.act),
            "difficulty",
        )?;
        write_u32_le_at(&mut encoded_bytes, OFFSET_MAP_SEED, character.map_seed, "map_seed")?;
        write_exact_bytes(
            &mut encoded_bytes,
            RANGE_MERCENARY.clone(),
            &character.mercenary.write(),
            "mercenary",
        )?;
        write_exact_bytes(
            &mut encoded_bytes,
            RANGE_RESURRECTED_MENU_APPEARANCE.clone(),
            &character.resurrected_menu_appearance,
            "resurrected_menu_appearance",
        )?;
        write_name_string(&mut encoded_bytes, RANGE_NAME.clone(), &character.name, "name")?;

        write_u8_at(
            &mut encoded_bytes,
            OFFSET_RESERVED_VERSION_MARKER_ONE,
            0x10,
            "reserved_version_marker_one",
        )?;
        write_u8_at(
            &mut encoded_bytes,
            OFFSET_RESERVED_VERSION_MARKER_TWO,
            0x1E,
            "reserved_version_marker_two",
        )?;
        let mode_marker = mode_marker_for_encode(character);
        write_u8_at(&mut encoded_bytes, OFFSET_MODE_MARKER, mode_marker, "mode_marker")?;
        write_exact_bytes(
            &mut encoded_bytes,
            RANGE_RESERVED_CHECKSUM_MASK.clone(),
            &[0xFF, 0xFF, 0xFF, 0xFF],
            "reserved_checksum_mask",
        )?;

        Ok(encoded_bytes)
    }
}