war3parser 0.5.3

A extractor and parser for Warcraft 3 map files
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

//! # war3parser
//!
//! A library for parsing and extracting Warcraft III map files
//! (`.w3x` / `.w3m`).
//!
//! ## Crate layout
//!
//! - [`archive`] — the map container: optional `HM3W` header + embedded MPQ
//! - [`carve`] — metadata salvage for archives whose MPQ tables are unreadable
//! - [`formats`] — parsers for the member files (`w3i`, `wts`, `imp`, `mmp`)
//! - [`model`] — portable data structures shared by CLI / WASM / library users
//! - [`reader`] — bounds-checked little-endian [`reader::ByteReader`]
//! - [`error`] — the crate-wide [`error::Error`] type
//!
//! The `war3map.w3i` parser supports the full format-version ladder
//! **v8 → v33** (Reign of Chaos betas through WC3 2.0); see
//! [`formats::w3i::FormatVersion`].
//!
//! ## Features
//!
//! | Feature | Default | Purpose |
//! |---------|---------|---------|
//! | `serde` | yes     | JSON serialization for dumps and the WASM bridge |
//! | `carve` | yes     | [`carve`] salvage for unreadable archives (pulls in `flate2`) |
//!
//! ## Example
//!
//! ```ignore
//! use war3parser::prelude::*;
//!
//! let buffer = std::fs::read("path/to/map.w3x")?;
//! let mut metadata = War3MapMetadata::parse(&buffer)?;
//! metadata.resolve_trigger_strings();
//! let snapshot = metadata.snapshot()?;
//! println!("{:?}", snapshot.map_info.map(|i| i.name));
//! ```

pub mod archive;
#[cfg(feature = "carve")]
pub mod carve;
pub mod error;
pub mod formats;
pub mod model;
pub mod modscan;
pub mod reader;

/// The most commonly used types in one import.
pub mod prelude {
    #[doc(inline)]
    pub use crate::archive::War3MapW3x;
    #[cfg(feature = "carve")]
    #[doc(inline)]
    pub use crate::carve::{carve, Carved};
    #[doc(inline)]
    pub use crate::error::Error;
    #[doc(inline)]
    pub use crate::formats::{
        imp::War3MapImp,
        mmp::{MinimapIcon, War3MapMmp},
        w3i::{FormatVersion, War3MapW3i},
        wts::War3MapWts,
    };
    #[doc(inline)]
    pub use crate::model::{
        ImportEntry, MapSnapshot, StringTableEntry, War3Image, War3ImageData, War3MapHeader,
        War3MapMetadata, HM3W_MAGIC,
    };
    #[doc(inline)]
    pub use crate::modscan::ModInfo;
}

#[doc(inline)]
pub use crate::{
    archive::War3MapW3x,
    error::Error,
    model::{
        ImportEntry, MapSnapshot, StringTableEntry, War3Image, War3ImageData, War3MapHeader,
        War3MapMetadata,
    },
    modscan::ModInfo,
};