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

use crate::character::codec::CharacterCodec;
use crate::character::v105::{MODE_ROTW, OFFSET_MODE_MARKER};
use crate::character::*;
use crate::format::FormatId;
use crate::ExpansionType;

#[test]
fn character_parse_test() {
    let bytes: [u8; 319] = [
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x28, 0x0F, 0x00, 0x00, 0x01, 0x10, 0x1E, 0x5C, 0x00, 0x00,
        0x00, 0x00, 0xBB, 0x29, 0xBD, 0x64, 0xFF, 0xFF, 0xFF, 0xFF, 0x28, 0x00, 0x00, 0x00, 0x3B,
        0x00, 0x00, 0x00, 0x36, 0x00, 0x00, 0x00, 0x2A, 0x00, 0x00, 0x00, 0x2B, 0x00, 0x00, 0x00,
        0xFF, 0xFF, 0x00, 0x00, 0xFF, 0xFF, 0x00, 0x00, 0x9B, 0x00, 0x00, 0x00, 0x95, 0x00, 0x00,
        0x00, 0x34, 0x00, 0x00, 0x00, 0xDC, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0x00, 0x00, 0xFF, 0xFF,
        0x00, 0x00, 0xFF, 0xFF, 0x00, 0x00, 0xFF, 0xFF, 0x00, 0x00, 0xFF, 0xFF, 0x00, 0x00, 0x37,
        0x00, 0x00, 0x00, 0x36, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x36, 0x00, 0x00, 0x00,
        0x39, 0x03, 0x02, 0x02, 0x02, 0x35, 0xFF, 0x51, 0x02, 0x02, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
        0xFF, 0x4D, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
        0xFF, 0xFF, 0x00, 0x00, 0x80, 0x43, 0x2D, 0x95, 0x53, 0x00, 0x00, 0x00, 0x00, 0x19, 0x50,
        0x40, 0x5C, 0x07, 0x00, 0x23, 0x00, 0xD6, 0x9B, 0x19, 0x06, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x6F, 0x62, 0x61, 0x20, 0xFF, 0x07, 0x1C,
        0x01, 0x04, 0x00, 0x00, 0x00, 0x75, 0x69, 0x74, 0x20, 0xFF, 0x02, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x78, 0x70, 0x6C, 0x20, 0xFF, 0x07, 0xD9, 0x00, 0x00, 0x00, 0x00, 0x00, 0x75,
        0x61, 0x70, 0x20, 0x4D, 0x07, 0xF8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x4E, 0x79, 0x61, 0x68,
        0x61, 0x6C, 0x6C, 0x6F, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00,
    ];

    let expected_result = Character {
        weapon_switch: false,
        status: Status { expansion: true, hardcore: false, ladder: false, died: true },
        class: Class::Sorceress,
        level: 92,
        last_played: 1690118587,
        progression: 15,
        assigned_skills: [
            40, 59, 54, 42, 43, 65535, 65535, 155, 149, 52, 220, 65535, 65535, 65535, 65535, 65535,
        ],
        left_mouse_skill: 55,
        right_mouse_skill: 54,
        left_mouse_switch_skill: 0,
        right_mouse_switch_skill: 54,
        menu_appearance: [
            57, 3, 2, 2, 2, 53, 255, 81, 2, 2, 255, 255, 255, 255, 255, 255, 77, 255, 255, 255,
            255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
        ],
        difficulty: Difficulty::Hell,
        act: Act::Act1,
        map_seed: 1402285379,
        mercenary: Mercenary {
            is_dead: false,
            id: 1547718681,
            name_id: 7,
            variant_id: 35,
            experience: 102341590,
        },
        resurrected_menu_appearance: [
            111, 98, 97, 32, 255, 7, 28, 1, 4, 0, 0, 0, 117, 105, 116, 32, 255, 2, 0, 0, 0, 0, 0,
            0, 120, 112, 108, 32, 255, 7, 217, 0, 0, 0, 0, 0, 117, 97, 112, 32, 77, 7, 248, 0, 0,
            0, 0, 0,
        ],
        name: String::from("Nyahallo"),
        raw_section: bytes.to_vec(),
    };
    let parsed_result = CharacterCodecV99::decode(&bytes).expect("character should parse");
    assert_eq!(parsed_result, expected_result);
}

#[test]
fn character_write_test() {
    let expected_result: [u8; 319] = [
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x28, 0x0F, 0x00, 0x00, 0x01, 0x10, 0x1E, 0x5C, 0x00, 0x00,
        0x00, 0x00, 0xBB, 0x29, 0xBD, 0x64, 0xFF, 0xFF, 0xFF, 0xFF, 0x28, 0x00, 0x00, 0x00, 0x3B,
        0x00, 0x00, 0x00, 0x36, 0x00, 0x00, 0x00, 0x2A, 0x00, 0x00, 0x00, 0x2B, 0x00, 0x00, 0x00,
        0xFF, 0xFF, 0x00, 0x00, 0xFF, 0xFF, 0x00, 0x00, 0x9B, 0x00, 0x00, 0x00, 0x95, 0x00, 0x00,
        0x00, 0x34, 0x00, 0x00, 0x00, 0xDC, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0x00, 0x00, 0xFF, 0xFF,
        0x00, 0x00, 0xFF, 0xFF, 0x00, 0x00, 0xFF, 0xFF, 0x00, 0x00, 0xFF, 0xFF, 0x00, 0x00, 0x37,
        0x00, 0x00, 0x00, 0x36, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x36, 0x00, 0x00, 0x00,
        0x39, 0x03, 0x02, 0x02, 0x02, 0x35, 0xFF, 0x51, 0x02, 0x02, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
        0xFF, 0x4D, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
        0xFF, 0xFF, 0x00, 0x00, 0x80, 0x43, 0x2D, 0x95, 0x53, 0x00, 0x00, 0x00, 0x00, 0x19, 0x50,
        0x40, 0x5C, 0x07, 0x00, 0x23, 0x00, 0xD6, 0x9B, 0x19, 0x06, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x6F, 0x62, 0x61, 0x20, 0xFF, 0x07, 0x1C,
        0x01, 0x04, 0x00, 0x00, 0x00, 0x75, 0x69, 0x74, 0x20, 0xFF, 0x02, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x78, 0x70, 0x6C, 0x20, 0xFF, 0x07, 0xD9, 0x00, 0x00, 0x00, 0x00, 0x00, 0x75,
        0x61, 0x70, 0x20, 0x4D, 0x07, 0xF8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x4E, 0x79, 0x61, 0x68,
        0x61, 0x6C, 0x6C, 0x6F, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00,
    ];

    let character = Character {
        weapon_switch: false,
        status: Status { expansion: true, hardcore: false, ladder: false, died: true },
        progression: 15,
        class: Class::Sorceress,
        level: 92,
        last_played: 1690118587,
        assigned_skills: [
            40, 59, 54, 42, 43, 65535, 65535, 155, 149, 52, 220, 65535, 65535, 65535, 65535, 65535,
        ],
        left_mouse_skill: 55,
        right_mouse_skill: 54,
        left_mouse_switch_skill: 0,
        right_mouse_switch_skill: 54,
        menu_appearance: [
            57, 3, 2, 2, 2, 53, 255, 81, 2, 2, 255, 255, 255, 255, 255, 255, 77, 255, 255, 255,
            255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
        ],
        difficulty: Difficulty::Hell,
        act: Act::Act1,
        map_seed: 1402285379,
        mercenary: Mercenary {
            is_dead: false,
            id: 1547718681,
            name_id: 7,
            variant_id: 35,
            experience: 102341590,
        },
        resurrected_menu_appearance: [
            111, 98, 97, 32, 255, 7, 28, 1, 4, 0, 0, 0, 117, 105, 116, 32, 255, 2, 0, 0, 0, 0, 0,
            0, 120, 112, 108, 32, 255, 7, 217, 0, 0, 0, 0, 0, 117, 97, 112, 32, 77, 7, 248, 0, 0,
            0, 0, 0,
        ],
        name: String::from("Nyahallo"),
        raw_section: expected_result.to_vec(),
    };
    let generated_result = CharacterCodecV99::encode(&character).expect("character should encode");

    assert_eq!(expected_result.to_vec(), generated_result);
}

#[test]
fn character_v105_parse_test() {
    let save_bytes = include_bytes!("../../assets/test/Warlock_v105.d2s");
    let section_start = 16usize;
    let section_end = section_start + expected_length_for_format(FormatId::V105);
    let character_bytes = &save_bytes[section_start..section_end];

    let parsed = CharacterCodecV105::decode(character_bytes).expect("v105 character should parse");

    assert_eq!(parsed.class, Class::Warlock);
    assert_eq!(parsed.level, 1);
    assert_eq!(parsed.raw_section[OFFSET_MODE_MARKER], MODE_ROTW);
    assert_eq!(parsed.raw_section, character_bytes);
}

#[test]
fn character_v105_write_roundtrip_test() {
    let save_bytes = include_bytes!("../../assets/test/Warlock_v105.d2s");
    let section_start = 16usize;
    let section_end = section_start + expected_length_for_format(FormatId::V105);
    let character_bytes = &save_bytes[section_start..section_end];

    let parsed = CharacterCodecV105::decode(character_bytes).expect("v105 character should parse");
    let encoded = CharacterCodecV105::encode(&parsed).expect("v105 character should encode");

    assert_eq!(encoded, character_bytes);
}

#[test]
fn title_helper_maps_default_d2r_rules() {
    let mut character = Character { class: Class::Amazon, ..Character::default() };

    character.set_legacy_expansion_flag(false);
    character.set_hardcore(false);
    character.progression = 4;
    assert_eq!(character.title_d2r(ExpansionType::Classic), Some("Dame"));

    character.set_legacy_expansion_flag(false);
    character.set_hardcore(true);
    character.progression = 12;
    assert_eq!(character.title_d2r(ExpansionType::Classic), Some("Queen"));

    character.set_legacy_expansion_flag(true);
    character.set_hardcore(false);
    character.progression = 10;
    assert_eq!(character.title_d2r(ExpansionType::Expansion), Some("Champion"));

    character.set_legacy_expansion_flag(true);
    character.set_hardcore(true);
    character.progression = 15;
    assert_eq!(character.title_d2r(ExpansionType::Expansion), Some("Guardian"));

    // Warlock uses male title variants.
    character.class = Class::Warlock;
    character.set_legacy_expansion_flag(false);
    character.set_hardcore(false);
    character.progression = 12;
    assert_eq!(character.title_d2r(ExpansionType::Classic), Some("Baron"));

    // Expansion normally skips these values.
    character.set_legacy_expansion_flag(true);
    character.set_hardcore(false);
    character.progression = 9;
    assert_eq!(character.title_d2r(ExpansionType::Expansion), None);
}