war3parser 0.4.0

A extractor and parser for Warcraft 3 map files
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

use war3parser::formats::w3i::FormatVersion;
use war3parser::prelude::*;

const MAPS: &[(&str, FormatVersion, bool)] = &[
    // (path relative to crate, expected w3i version, expect_hm3w)
    (
        "../../test_data/DotA v6.83dAI PMV 1.42 EN.w3x",
        FormatVersion::V25,
        true,
    ),
    (
        "../../test_data/Legion_TD_11.1c_TeamOZE.w3x",
        FormatVersion::V31,
        true,
    ),
    (
        "../../test_data/TowerSurvivorsv1.71.w3x",
        FormatVersion::V31,
        false,
    ),
];

#[test]
fn all_fixtures_parse_w3i() {
    for (path, expected_version, expect_hm3w) in MAPS {
        let buffer = std::fs::read(path).unwrap_or_else(|e| panic!("read {path}: {e}"));
        let mut w3x =
            War3MapW3x::from_buffer(&buffer).unwrap_or_else(|e| panic!("w3x {path}: {e}"));
        assert_eq!(
            w3x.header.has_hm3w, *expect_hm3w,
            "{path} hm3w expected {expect_hm3w}"
        );

        let info = w3x
            .read_map_info()
            .unwrap_or_else(|e| panic!("w3i {path}: {e:?}"));
        assert_eq!(info.version, *expected_version, "{path} w3i version");
        assert!(!info.players.is_empty(), "{path} has players");
        assert!(!info.forces.is_empty(), "{path} has forces");
        println!(
            "OK {path}: {} name={:?} players={} forces={} skipped={}",
            info.version,
            info.name,
            info.players.len(),
            info.forces.len(),
            info.skipped_optional_sections
        );
    }
}

#[test]
fn metadata_resolves_trigger_strings() {
    for (path, _, _) in MAPS {
        let buffer = std::fs::read(path).unwrap();
        let mut meta = War3MapMetadata::parse(&buffer).expect("metadata");
        assert!(meta.map_info.is_some(), "{path} map_info");
        assert!(meta.wts.is_some(), "{path} should have wts");
        meta.resolve_trigger_strings();
        let info = meta.map_info.as_ref().unwrap();
        assert!(
            !info.name.starts_with("TRIGSTR_"),
            "{path} name still unresolved: {:?}",
            info.name
        );
    }
}

#[test]
fn dota_skips_optional_sections() {
    let path = "../../test_data/DotA v6.83dAI PMV 1.42 EN.w3x";
    let buffer = std::fs::read(path).unwrap();
    let mut w3x = War3MapW3x::from_buffer(&buffer).unwrap();
    let info = w3x.read_map_info().unwrap();
    assert!(info.skipped_optional_sections);
    assert!(info.upgrade_availability_changes.is_empty());
    assert!(info.random_item_tables.is_empty());
}

#[test]
fn legion_wts_has_many_strings() {
    let path = "../../test_data/Legion_TD_11.1c_TeamOZE.w3x";
    let buffer = std::fs::read(path).unwrap();
    let mut w3x = War3MapW3x::from_buffer(&buffer).unwrap();
    let wts = w3x.read_string_table().unwrap();
    assert!(
        wts.string_map.len() > 500,
        "expected rich WTS, got {}",
        wts.string_map.len()
    );
}

#[test]
fn tower_has_imports() {
    let path = "../../test_data/TowerSurvivorsv1.71.w3x";
    let buffer = std::fs::read(path).unwrap();
    let mut w3x = War3MapW3x::from_buffer(&buffer).unwrap();
    let imp = w3x.read_imports().unwrap();
    assert!(!imp.entries.is_empty());
}

#[test]
fn tower_minimap_icons() {
    let path = "../../test_data/TowerSurvivorsv1.71.w3x";
    let buffer = std::fs::read(path).unwrap();
    let mut w3x = War3MapW3x::from_buffer(&buffer).unwrap();
    let mmp = w3x.read_minimap_icons().expect("mmp");
    assert_eq!(mmp.icons.len(), 8);
    assert!(mmp.icons.iter().all(|i| i.icon_type == 2));
    // first tower player should be roughly red-ish after BGRA→RGBA
    let c = mmp.icons[0].color;
    assert!(c[0] > 200, "expected red channel high, got {c:?}");
}

#[test]
fn dota_minimap_has_buildings_and_starts() {
    let path = "../../test_data/DotA v6.83dAI PMV 1.42 EN.w3x";
    let buffer = std::fs::read(path).unwrap();
    let meta = War3MapMetadata::parse(&buffer).unwrap();
    let mmp = meta.minimap_icons.expect("mmp");
    assert!(mmp.icons.iter().any(|i| i.icon_type == 1));
    assert!(mmp.icons.iter().any(|i| i.icon_type == 2));
}

#[test]
fn snapshot_shape_is_stable() {
    let path = "../../test_data/TowerSurvivorsv1.71.w3x";
    let buffer = std::fs::read(path).unwrap();
    let snapshot = War3MapMetadata::parse_snapshot(&buffer).unwrap();
    assert!(snapshot.map_info.is_some());
    assert!(!snapshot.images.is_empty());
    assert!(snapshot.imports.as_ref().is_some_and(|i| !i.is_empty()));
    assert!(snapshot.strings.as_ref().is_some_and(|s| !s.is_empty()));
    assert!(snapshot.files.as_ref().is_some_and(|f| !f.is_empty()));

    // w3i version must serialize as a plain number (WASM d.ts contract)
    let json = serde_json::to_value(&snapshot).unwrap();
    assert!(json["map_info"]["version"].is_number());
}