whiteoutlib 0.1.4

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

// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2026 Fernando Sahmkow
/// @file config.h
/// @brief CASC configuration file parsers (.build.info, build config, CDN config, shmem).
///
/// Internal header — not part of the public include path.
#pragma once

#include <whiteout/common_types.h>

#include <array>
#include <span>
#include <string>
#include <vector>

namespace whiteout::storages::casc {

// ============================================================================
// .build.info
// ============================================================================

struct BuildInfo {
    std::string branch;
    bool active = false;
    std::array<u8, 16> buildKey{};
    std::array<u8, 16> cdnKey{};
    std::string cdnPath;
    std::string version;
    std::string product;
};

/// Parse `.build.info` TSV with typed column headers.
std::vector<BuildInfo> parseBuildInfo(std::span<const u8> data);

/// Parse a flavor subdirectory's `.flavor.info` and return its "Product Flavor"
/// code (e.g. "w3t" for a `_ptr_` directory), or an empty string if absent.
std::string parseFlavorInfo(std::span<const u8> data);

// ============================================================================
// Build Config
// ============================================================================

struct BuildConfig {
    std::array<u8, 16> rootCKey{};
    std::array<u8, 16> encodingCKey{};
    std::array<u8, 16> encodingEKey{};
    u64 encodingSize = 0;
    std::array<u8, 16> downloadCKey{};
    std::array<u8, 16> installCKey{};
    std::string buildName;
    std::string buildProduct;
    std::string buildUid;
    // VFS fields (WC3 Reforged+)
    std::array<u8, 16> vfsRootCKey{};
    std::array<u8, 16> vfsRootEKey{};
    /// CKey+EKey pairs of vfs-1 .. vfs-N sub-manifests.
    struct VfsManifest {
        std::array<u8, 16> cKey{};
        std::array<u8, 16> eKey{};
    };
    std::vector<VfsManifest> vfsSubManifests;
};

/// Parse a build configuration file (key = value format, `#` comments).
BuildConfig parseBuildConfig(std::span<const u8> data);

// ============================================================================
// CDN Config
// ============================================================================

struct CdnConfig {
    std::vector<std::array<u8, 16>> archiveEKeys;
    std::vector<u32> archiveIndexSizes;
    std::string fileIndex;
    u32 fileIndexSize = 0;
};

/// Parse a CDN configuration file.
CdnConfig parseCdnConfig(std::span<const u8> data);

// ============================================================================
// Shmem
// ============================================================================

struct ShmemInfo {
    u32 archiveCount = 0;
    u32 version = 0;
};

/// Parse the shmem binary file.
ShmemInfo parseShmem(std::span<const u8> data);

// ============================================================================
// TSV Table (shared parser)
// ============================================================================

/// Generic TSV table: column names + row data.
struct TsvTable {
    std::vector<std::string> columns;
    std::vector<std::vector<std::string>> rows;
};

/// Parse a TSV table with typed column headers (e.g. "Col!TYPE:SIZE|...").
TsvTable parseTsv(std::span<const u8> data);

// ============================================================================
// Online: Versions / CDNs Endpoint Responses
// ============================================================================

struct VersionInfo {
    std::string region;
    std::array<u8, 16> buildConfigKey{};
    std::array<u8, 16> cdnConfigKey{};
    std::array<u8, 16> keyRing{};
    u32 buildId = 0;
    std::string versionName;
    std::string productConfig;
};

struct CdnInfo {
    std::string region;
    std::string path;
    std::vector<std::string> hosts;
    std::string configPath;
};

/// Parse `/v2/products/{product}/versions` TSV response.
std::vector<VersionInfo> parseVersionsResponse(std::span<const u8> data);

/// Parse `/v2/products/{product}/cdns` TSV response.
std::vector<CdnInfo> parseCdnsResponse(std::span<const u8> data);

} // namespace whiteout::storages::casc