whiteoutlib 0.1.0

Parsers and writers for Blizzard model and texture formats (MDX, M2, M3, BLP, DDS, PNG).
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180


#include "file_system.h"

#include <iomanip>
#include <sstream>
#include <string>

namespace whiteout {
namespace m2 {

namespace {

std::string format_number(int num, int width) {
    std::ostringstream oss;
    oss << std::setfill('0') << std::setw(width) << num;
    return oss.str();
}

std::string format_anim_id(int anim_id, int variant) {
    std::ostringstream oss;
    oss << std::setfill('0') << std::setw(4) << anim_id << "-" << std::setw(2) << variant;
    return oss.str();
}

std::optional<std::pair<int, int>> parseAnimSuffix(std::string_view s) {

    if (s.size() < 11)
        return std::nullopt;
    if (s[4] != '-' || s.substr(7) != ".anim")
        return std::nullopt;

    int const anim = std::stoi(std::string(s.substr(0, 4)));
    int const var = std::stoi(std::string(s.substr(5, 2)));
    return {{anim, var}};
}

std::optional<int> parseBaseSkin(std::string_view s) {

    if (!s.ends_with(".skin"))
        return std::nullopt;
    return std::stoi(std::string(s.substr(0, s.size() - 5)));
}

std::optional<int> parseLodSkin(std::string_view s) {

    if (!s.starts_with("_lod") || !s.ends_with(".skin"))
        return std::nullopt;
    return std::stoi(std::string(s.substr(4, 2)));
}

std::optional<int> parseBone(std::string_view s) {

    if (!s.starts_with("_") || !s.ends_with(".bone"))
        return std::nullopt;
    return std::stoi(std::string(s.substr(1, s.size() - 6)));
}

} // namespace

std::optional<GroupedFiles> collectBundle(const std::filesystem::path& m2Path) {
    using namespace std::filesystem;

    GroupedFiles out;
    out.m2 = m2Path;
    if (!m2Path.has_extension()) {
        out.m2 += ".m2";
    }

    if (out.m2.extension() != ".m2") {
        return std::nullopt;
    }

    if (out.m2.is_relative()) {
        out.m2 = current_path() / out.m2;
    }

    const path dir = out.m2.parent_path();
    const std::string base = out.m2.stem().string();

    for (const directory_entry& e : directory_iterator(dir)) {
        if (!e.is_regular_file()) {
            continue;
        }

        const path& p = e.path();
        const std::string name = p.filename().string();

        if (!name.starts_with(base)) {
            continue;
        }

        const std::string suffix = name.substr(base.size());
        const std::string ext = p.extension().string();

        if (ext == ".skel") {
            if (name == base + ".skel") {
                out.skel = p;
            }
        } else if (ext == ".anim") {
            if (auto av = parseAnimSuffix(suffix)) {
                auto& [animId, variant] = *av;
                out.anims[animId].variants[variant] = p;
            }
        } else if (ext == ".skin") {
            if (auto lod = parseLodSkin(suffix)) {
                out.lodSkins[*lod] = p;
            } else if (auto idx = parseBaseSkin(suffix)) {
                out.baseSkins[*idx] = p;
            }
        } else if (ext == ".bone") {
            if (auto idx = parseBone(suffix)) {
                out.bones[*idx] = p;
            }
        }
    }

    return out;
}

GroupedFiles fromFileSystem(const FileSystem& fsys, std::filesystem::path whereTo) {
    namespace fs = std::filesystem;
    std::filesystem::path dir = whereTo;
    std::filesystem::path base = whereTo.stem();
    if (base.empty()) {
        if (fsys.baseName.empty()) {
            base = "just_another_model";
        } else {
            base = std::filesystem::path(fsys.baseName).stem();
        }
    } else {
        dir = whereTo.parent_path();
    }

    if (dir.is_relative()) {
        dir = std::filesystem::current_path() / dir;
    }

    fs::create_directories(dir);

    GroupedFiles out;

    out.m2 = dir / fs::path(base.string() + ".m2");

    if (fsys.skeleton.has_value()) {
        out.skel = dir / fs::path(base.string() + ".skel");
    }

    for (const SkinFile& skin : fsys.skins) {
        if (skin.isLodSkin) {
            fs::path const p =
                dir / fs::path(base.string() + "_lod" + format_number(skin.lodLevel, 2) + ".skin");

            out.lodSkins[skin.lodLevel] = p;
        } else {
            fs::path const p =
                dir / fs::path(base.string() + format_number(skin.index, 2) + ".skin");

            out.baseSkins[skin.index] = p;
        }
    }

    for (const AnimFile& anim : fsys.anims) {
        fs::path const p =
            dir / fs::path(base.string() + format_anim_id(anim.animId, anim.variant) + ".anim");

        out.anims[anim.animId].variants[anim.variant] = p;
    }

    for (size_t i = 0; i < fsys.bones.size(); ++i) {
        fs::path const p =
            dir / fs::path(base.string() + "_" + format_number(static_cast<int>(i), 2) + ".bone");

        out.bones[static_cast<int>(i)] = p;
    }

    return out;
}

} // namespace m2
} // namespace whiteout