whiteoutlib 0.1.6

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

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

#pragma once

#if !defined(WHITEOUT_HAS_CASC)
#error                                                                                             \

    "<whiteout/utils/casc_file_system.h> requires CASC support. Configure with -DWHITEOUT_ENABLE_CASC=ON and link against " \
    "the whiteout_casc target."
#endif

#include <memory>
#include <string>
#include <vector>

#include <whiteout/common_types.h>
#include <whiteout/interfaces.h>

namespace whiteout::storages::casc {
class Storage;
}

namespace whiteout::utils {

/// CascFileSystem implementation backed by a CASC archive (numeric file-data-ID).
///
/// The Storage must outlive this object — CascFileSystem holds a non-owning
/// reference to it.
///
/// If the underlying Storage is writable (StorageWritable), write operations
/// are forwarded to the write overlay. Otherwise writeFile() returns false
/// and reserveFileId() returns std::nullopt.
///
/// Requires the `whiteout_casc` CMake target.
///
/// Example:
///   auto storage = casc::Storage::open("C:/Games/WoW/Data");
///   utils::CascFileSystem fs(*storage);
///   auto data = fs.readFile(12345);
class CascFileSystem : public interfaces::CascFileSystem {
public:
    explicit CascFileSystem(storages::casc::Storage& storage);
    ~CascFileSystem() override;

    CascFileSystem(const CascFileSystem&) = delete;
    CascFileSystem& operator=(const CascFileSystem&) = delete;

    CascFileSystem(CascFileSystem&&) noexcept;
    CascFileSystem& operator=(CascFileSystem&&) noexcept;

    std::vector<u8> readFile(u32 fileId) const override;
    std::optional<u32> reserveFileId(const std::string& path) override;
    bool writeFile(u32 fileId, const std::vector<u8>& data) override;
    bool fileExists(u32 fileId) const override;

private:
    struct Impl;
    std::unique_ptr<Impl> m_impl;
};

/// VirtualPathFileSystem implementation backed by a CASC archive (path-based).
///
/// The Storage must outlive this object — CascPathFileSystem holds a non-owning
/// reference to it.
///
/// Path separators: both '/' and '\\' are accepted and treated identically.
/// Filename comparison is case-insensitive, matching CASC archive semantics.
///
/// If the underlying Storage is writable (StorageWritable), write operations
/// are forwarded to the write overlay. Otherwise writeFile() returns false.
///
/// Requires the `whiteout_casc` CMake target.
///
/// Example:
///   auto storage = casc::Storage::open("C:/Games/WoW/Data");
///   utils::CascPathFileSystem fs(*storage);
///   auto data = fs.readFile("data\\global\\excel\\items.txt");
class CascPathFileSystem : public interfaces::VirtualPathFileSystem {
public:
    explicit CascPathFileSystem(storages::casc::Storage& storage);
    ~CascPathFileSystem() override;

    CascPathFileSystem(const CascPathFileSystem&) = delete;
    CascPathFileSystem& operator=(const CascPathFileSystem&) = delete;

    CascPathFileSystem(CascPathFileSystem&&) noexcept;
    CascPathFileSystem& operator=(CascPathFileSystem&&) noexcept;

    std::vector<u8> readFile(const std::string& path) const override;
    bool writeFile(const std::string& path, const std::vector<u8>& data) override;
    bool fileExists(const std::string& path) const override;
    std::vector<interfaces::DirectoryEntry> listDirectory(const std::string& path) const override;

private:
    struct Impl;
    std::unique_ptr<Impl> m_impl;
};

} // namespace whiteout::utils