Crate war3parser

War3Parser

war3parser is a library for parsing and extracting Warcraft III map files.

Features

• Extract files from MPQ archives. (As long as the file name is known and the file exists in the MPQ)
• Parse file formats into Rust structs

Supported parse targets

• W3X: War3MapW3x
• W3I: War3MapW3i
• WTS: War3MapWts
• BLP: BlpImage
• TGA: TgaImage

And a helper struct to include all supported metadata of a map file: War3MapMetadata

Implementation

Most of the struct implemented BinaryReadable trait, which provides a load function to load the struct from a binary reader.

We use the trait implementation chain to load the struct from a file.

Modules

• parser
  Parsers to do the actual parsing
• war3map_metadata
  Helper struct that includes all supported metadata of a map file Helper struct that includes all supported metadata of a map file

Structs

• BlpImage
  BLP image
• TgaImage
  TGA image
• War3Image
  Image with basic metadata and image::RgbaImage data
• War3MapImp
  Import table
• War3MapMetadata
  If file exists and extracted successfully, the struct is Some(..) Otherwise, the struct is None
• War3MapW3i
  Map info for war3map.w3i file
• War3MapW3x
  Warcraft 3 map entry
• War3MapWts
  String table

Enums

• ParserError
  Custom error types

Traits

• BinaryReadable
  Trait to load from binary array and parse it into a struct