whiteoutlib 0.1.2

Read and write Blizzard game assets from Rust: models (MDX, M2, M3), textures (BLP, DDS, PNG, JPEG, BMP, TGA, TIFF, GIF) and archives (CASC, MPQ).
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

// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2026 Fernando Sahmkow

BinaryParseVisitor::BinaryParseVisitor(BinaryReader& reader, bool ismd33) : reader(reader) {
    (void)ismd33;
}

void BinaryParseVisitor::read(Model& model) {
    MD3Header header = reader.read<MD3Header>();

    if (header.magic == TAG_MD34) { // "MD34" or "MD33"
        readReferenceFunc = [this]() {
            Reference ref = this->reader.read<Reference>();
            return ref;
        };
    } else {
        readReferenceFunc = [this]() {
            Reference ref;
            ref.entries = this->reader.read<u32>();
            ref.index = this->reader.read<u32>();
            // MD33 doesn't have flags
            return ref;
        };
    }

    reader.setPosition(header.indexOffset);
    indexTable = reader.read<std::vector<IndexEntry>>(header.indexCount);
    indexUsed.resize(header.indexCount, false);

    reader.setPosition(indexTable[header.modelRef.index].offset);
    indexUsed[0] = true; // Mark the MD34 header as used
    indexUsed[header.modelRef.index] = true;
    visit(model, indexTable[header.modelRef.index].version);
    for (size_t i = 0; i < indexUsed.size(); ++i) {
        if (!indexUsed[i]) {
            issues.emplace_back("Index entry " + std::to_string(i) +
                                " was not used during parsing.");
            issues.emplace_back("  Tag: " + tagToString(indexTable[i].tag) +
                                ", Count: " + std::to_string(indexTable[i].count) +
                                ", Version: " + std::to_string(indexTable[i].version));
        }
    }
}

void BinaryParseVisitor::visit(Model& model, u32 version) {
    detail::setStructureVersion(model, version);
    visit(model.name);
    model.flags = static_cast<ModelFlag>(reader.read<u32>());
    visit(model.sequences);
    visit(model.subTrackCollections);
    visit(model.animationGroups);
    visit(model.boneAnimationSets);
    model.animationSplitCount = reader.read<u32>();
    visit(model.animationStates);
    visit(model.bones);
    model.skinBoneCount = reader.read<u32>();
    visit(model.vertices, 0);
    visit(model.divisions);
    visit(model.boneLookup);
    model.bounds = reader.read<Extent>();
    model.collisionBounds = reader.read<Extent>();
    visit(model.collisionFaces);
    visit(model.collisionVerts);
    visit(model.collisionNormals);

    visit(model.attachmentPoints);
    visit(model.attachmentPointAddons);
    visit(model.lights);
    if (version >= 21) {
        visit(model.shadowBoxes);
    }
    visit(model.cameras);
    visit(model.camerasAddons);

    visit(model.materialMaps);
    visit(model.standardMaterials);
    visit(model.displacementMaterials);
    visit(model.compositeMaterials);
    visit(model.terrainMaterials);
    visit(model.volumeMaterials);
    visit(model.hairMaterials);
    visit(model.creepMaterials);

    if (version >= 25) {
        visit(model.volumeNoiseMaterials);
    }
    if (version >= 26) {
        visit(model.stbMaterials);
    }
    if (version >= 28) {
        visit(model.reflectionMaterials);
    }
    if (version >= 29) {
        visit(model.lensFlareMaterials);
    }
    if (version >= 30) {
        visit(model.materialAddData);
    }

    visit(model.particleEmitters);
    visit(model.particleEmitterCopies);
    visit(model.ribbonEmitters);
    visit(model.projections);
    visit(model.forces);
    visit(model.warps);
    visit(model.viewVolumes);

    visit(model.rigidBodies);
    visit(model.physicsConstraints);
    visit(model.physicsJoints);
    if (version >= 28) {
        visit(model.clothPhysics);
    }
    visit(model.ikTwoJoints);
    if (version >= 24) {
        visit(model.ikCCD);
    }
    visit(model.ikJoints);
    visit(model.oneBoneSolvers);

    visit(model.turretBehaviors);
    visit(model.triggerData);
    visit(model.initialReference);

    visit(model.tightHitTestObject, 1);
    visit(model.fuzzyHitTestObjects);
    visit(model.attachmentVolumes);
    if (version >= 23) {
        visit(model.attachmentVolumesAddon0);
        visit(model.attachmentVolumesAddon1);
    }
    visit(model.billboardBehaviors);

    if (version >= 21) {
        visit(model.trailingModels);
        model.m3aAnimHash = reader.read<u32>();
    }
    if (version >= 23) {
        visit(model.m3aAnimHashes);
    }
}

void BinaryParseVisitor::visit(std::string& str) {
    Reference ref = readReferenceFunc();
    if (ref.entries == 0) {
        str.clear();
        return;
    }

    const auto currentPos = reader.getPosition();
    indexUsed[ref.index] = true;
    reader.setPosition(indexTable[ref.index].offset);
    assert(indexTable[ref.index].tag == ChunkTagTraits<char>::value);
    str = reader.readString(ref.entries, false);
    reader.setPosition(currentPos);
}

void BinaryParseVisitor::visit(std::string& str, u32 version) {
    (void)version;
    visit(str);
}