whiteoutlib 0.1.3

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

// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2026 Fernando Sahmkow
/// @file s1_root.h
/// @brief StarCraft Remastered / Agent text-based root handler.
///
/// S1 (and similar agent-based products like Hearthstone) use a plain-text root
/// where each line is:   filepath|ckey_hex
///                   or:  filepath:locale|ckey_hex
///
/// Internal header — not part of the public include path.
#pragma once

#include "common/entry_index.h"
#include "root.h"

#include <span>
#include <vector>

namespace whiteout::interfaces {
class WorkerPool;
}

namespace whiteout::storages::casc {

class S1Root final : public RootManifest {
public:
    /// Parse an S1-style text root file.
    /// @param data  Raw (BLTE-decoded) root file bytes (UTF-8 text).
    /// @param pool  Optional worker pool (unused, for API symmetry).
    /// @return Parsed root, or nullptr on failure.
    static std::unique_ptr<S1Root> parse(std::span<const u8> data,
                                         interfaces::WorkerPool* pool = nullptr);

    /// Heuristic check: does the buffer look like an S1 text root?
    /// Returns true if the data appears to be pipe-delimited text lines with
    /// hex content keys (not starting with '#' which is Overwatch).
    static bool looksLikeS1Root(std::span<const u8> data);

    // --- RootManifest interface ---
    std::vector<const RootEntry*> findByPath(const std::string& path) const override;
    std::vector<const RootEntry*> findByFileDataId(
        u32 fileDataId, FileIdHint hint = FileIdHint::None) const override;
    bool hasFileDataId(u32, FileIdHint = FileIdHint::None) const override {
        return false;
    }

    RootFormat format() const override {
        return RootFormat::Agent;
    }

protected:
    const std::vector<RootEntry>& entries() const override {
        return m_entries;
    }
    std::vector<RootEntry>& mutableEntries() override {
        return m_entries;
    }

private:
    std::vector<RootEntry> m_entries;

    /// Path-based lookup via Jenkins hash (fileNameHash).
    EntryIndex<u64> m_byNameHash;

    /// Path string-based lookup for exact path queries.
    EntryIndex<std::string> m_byPath;

    void buildIndices();
};

} // namespace whiteout::storages::casc