WhiteoutLib

Alpha Stage: This library is currently in early alpha. A lot of the design is actively being iterated on and may change significantly between versions.

WhiteoutLib is a C++ library for reading and writing 3D model, texture formats & storage formats used in Blizzard Entertainment games. It is inspired by StormLib, a library used by older Blizzard games to handle proprietary file formats like BLP, MDX, and MPQ.

Current 3D Format Support

• Warcraft III (.mdx)
  • Classic
  • Reforged
• World of Warcraft (.m2) (partial, still missing version specific parsing for older than Mist of panadaria and .phys and .bone files)
• StarCraft II / Heroes of the Storm (.m3/.m3a)
• Diablo III & IV (.acr,.app,.ani,.ans,.mat,.prt, SNO format family)

Planned Support

• Optimized parsers for Diablo III/IV .app, .ani, .acr, .prt, .mat, .ans

Current Texture Format Support

• Warcraft III & World of Warcraft (.blp) Both BLP1 (Warcraft III Classic) & BLP2 (World of Warcraft)
• Direct3D Surface (.dds)
• Diablo 3 & 4 (.tex)
• Standard formats .jpeg, .bmp, .png, .tga and .gif for saving only.
• Mipmap generation for PBR & Legacy pipelines, minding texture type and characteristics

Current Virtual File System Support

• Optional support of MPQ
• Optional support of CASC by wrapping CascLib

• Some formats are easier to parse using CASC, like m2 and sno.

Language Compatibility

The library internals use C++20, but all public headers are C++11 compatible to make it easier to create bindings for other languages.

Format References

look in docs/

Build

This project uses CMake.

cmake -S . -B build
cmake --build build --config Release

Examples

Example programs are available in examples/ for loading and writing supported formats.

License

BSD 3-Clause. See LICENSE.

Third-Party Notices

This project includes and/or references third-party components. See THIRD-PARTY-NOTICES.md for details.

Disclaimer

This project is not affiliated with or endorsed by Blizzard Entertainment.