wow-wmo 0.6.4

Parser, editor, and converter for World of Warcraft WMO (World Model Object) 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
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294

use binrw::BinWrite;
use std::io::Cursor;
use wow_wmo::api::{ParsedWmo, parse_wmo};
use wow_wmo::chunk_header::ChunkHeader;
use wow_wmo::chunk_id::ChunkId;

/// Helper to write a chunk to a buffer
fn write_chunk(buffer: &mut Vec<u8>, id: &str, data: &[u8]) {
    let header = ChunkHeader {
        id: ChunkId::from_bytes([
            id.as_bytes()[0],
            id.as_bytes()[1],
            id.as_bytes()[2],
            id.as_bytes()[3],
        ]),
        size: data.len() as u32,
    };
    let mut cursor = Cursor::new(buffer);
    cursor.set_position(cursor.get_ref().len() as u64);
    header.write(&mut cursor).unwrap();
    cursor.get_mut().extend_from_slice(data);
}

#[test]
fn test_parse_motx_chunk() {
    // MOTX contains null-terminated texture filenames
    let mut buffer = Vec::new();

    // MVER
    write_chunk(&mut buffer, "MVER", &[17, 0, 0, 0]);

    // MOHD (minimal header)
    let mohd_data = vec![0u8; 64];
    write_chunk(&mut buffer, "MOHD", &mohd_data);

    // MOTX - texture filenames
    let mut motx_data = Vec::new();
    motx_data.extend_from_slice(b"texture1.blp\0");
    motx_data.extend_from_slice(b"texture2.blp\0");
    motx_data.extend_from_slice(b"path/to/texture3.blp\0");
    write_chunk(&mut buffer, "MOTX", &motx_data);

    let mut cursor = Cursor::new(buffer);
    let result = parse_wmo(&mut cursor);

    assert!(result.is_ok());
    let wmo = result.unwrap();

    match wmo {
        ParsedWmo::Root(root) => {
            assert_eq!(root.textures.len(), 3);
            assert_eq!(root.textures[0], "texture1.blp");
            assert_eq!(root.textures[1], "texture2.blp");
            assert_eq!(root.textures[2], "path/to/texture3.blp");
        }
        _ => panic!("Expected root file"),
    }
}

#[test]
fn test_parse_mosb_chunk() {
    // MOSB contains skybox filename
    let mut buffer = Vec::new();

    // MVER
    write_chunk(&mut buffer, "MVER", &[17, 0, 0, 0]);

    // MOHD
    let mohd_data = vec![0u8; 64];
    write_chunk(&mut buffer, "MOHD", &mohd_data);

    // MOSB - skybox (optional, can be empty)
    write_chunk(&mut buffer, "MOSB", b"skybox.mdx\0");

    let mut cursor = Cursor::new(buffer);
    let result = parse_wmo(&mut cursor);

    assert!(result.is_ok());
    let wmo = result.unwrap();

    match wmo {
        ParsedWmo::Root(root) => {
            assert!(root.skybox.is_some());
            assert_eq!(root.skybox.unwrap(), "skybox.mdx");
        }
        _ => panic!("Expected root file"),
    }
}

#[test]
fn test_parse_mopv_chunk() {
    // MOPV contains portal vertices (Vec3 positions)
    let mut buffer = Vec::new();

    // MVER
    write_chunk(&mut buffer, "MVER", &[17, 0, 0, 0]);

    // MOHD with 1 portal
    let mut mohd_data = vec![0u8; 64];
    mohd_data[8..12].copy_from_slice(&1u32.to_le_bytes()); // n_portals = 1
    write_chunk(&mut buffer, "MOHD", &mohd_data);

    // MOPV - portal vertices (4 vertices for a quad)
    let mut mopv_data = Vec::new();
    // Vertex 0: (0, 0, 0)
    mopv_data.extend_from_slice(&0.0f32.to_le_bytes());
    mopv_data.extend_from_slice(&0.0f32.to_le_bytes());
    mopv_data.extend_from_slice(&0.0f32.to_le_bytes());
    // Vertex 1: (10, 0, 0)
    mopv_data.extend_from_slice(&10.0f32.to_le_bytes());
    mopv_data.extend_from_slice(&0.0f32.to_le_bytes());
    mopv_data.extend_from_slice(&0.0f32.to_le_bytes());
    // Vertex 2: (10, 10, 0)
    mopv_data.extend_from_slice(&10.0f32.to_le_bytes());
    mopv_data.extend_from_slice(&10.0f32.to_le_bytes());
    mopv_data.extend_from_slice(&0.0f32.to_le_bytes());
    // Vertex 3: (0, 10, 0)
    mopv_data.extend_from_slice(&0.0f32.to_le_bytes());
    mopv_data.extend_from_slice(&10.0f32.to_le_bytes());
    mopv_data.extend_from_slice(&0.0f32.to_le_bytes());

    write_chunk(&mut buffer, "MOPV", &mopv_data);

    let mut cursor = Cursor::new(buffer);
    let result = parse_wmo(&mut cursor);

    assert!(result.is_ok());
    let wmo = result.unwrap();

    match wmo {
        ParsedWmo::Root(root) => {
            assert_eq!(root.portal_vertices.len(), 4);
            assert_eq!(root.portal_vertices[0].x, 0.0);
            assert_eq!(root.portal_vertices[1].x, 10.0);
            assert_eq!(root.portal_vertices[2].y, 10.0);
            assert_eq!(root.portal_vertices[3].x, 0.0);
        }
        _ => panic!("Expected root file"),
    }
}

#[test]
fn test_parse_mopt_chunk() {
    // MOPT contains portal information (20 bytes per portal)
    let mut buffer = Vec::new();

    // MVER
    write_chunk(&mut buffer, "MVER", &[17, 0, 0, 0]);

    // MOHD with 1 portal
    let mut mohd_data = vec![0u8; 64];
    mohd_data[8..12].copy_from_slice(&1u32.to_le_bytes()); // n_portals = 1
    write_chunk(&mut buffer, "MOHD", &mohd_data);

    // MOPT - portal info (20 bytes)
    let mut mopt_data = Vec::new();
    mopt_data.extend_from_slice(&0u16.to_le_bytes()); // start_vertex
    mopt_data.extend_from_slice(&4u16.to_le_bytes()); // n_vertices
    mopt_data.extend_from_slice(&1.0f32.to_le_bytes()); // normal.x
    mopt_data.extend_from_slice(&0.0f32.to_le_bytes()); // normal.y
    mopt_data.extend_from_slice(&0.0f32.to_le_bytes()); // normal.z
    mopt_data.extend_from_slice(&5.0f32.to_le_bytes()); // distance

    write_chunk(&mut buffer, "MOPT", &mopt_data);

    let mut cursor = Cursor::new(buffer);
    let result = parse_wmo(&mut cursor);

    assert!(result.is_ok());
    let wmo = result.unwrap();

    match wmo {
        ParsedWmo::Root(root) => {
            assert_eq!(root.portals.len(), 1);
            assert_eq!(root.portals[0].start_vertex, 0);
            assert_eq!(root.portals[0].n_vertices, 4);
            assert_eq!(root.portals[0].normal.x, 1.0);
            assert_eq!(root.portals[0].distance, 5.0);
        }
        _ => panic!("Expected root file"),
    }
}

#[test]
fn test_parse_mopr_chunk() {
    // MOPR contains portal references (8 bytes per reference)
    let mut buffer = Vec::new();

    // MVER
    write_chunk(&mut buffer, "MVER", &[17, 0, 0, 0]);

    // MOHD
    let mohd_data = vec![0u8; 64];
    write_chunk(&mut buffer, "MOHD", &mohd_data);

    // MOPR - portal references
    let mut mopr_data = Vec::new();
    mopr_data.extend_from_slice(&1u16.to_le_bytes()); // portal_index
    mopr_data.extend_from_slice(&5u16.to_le_bytes()); // group_index
    mopr_data.extend_from_slice(&1i16.to_le_bytes()); // side (1 = positive, -1 = negative)
    mopr_data.extend_from_slice(&0u16.to_le_bytes()); // padding

    write_chunk(&mut buffer, "MOPR", &mopr_data);

    let mut cursor = Cursor::new(buffer);
    let result = parse_wmo(&mut cursor);

    assert!(result.is_ok());
    let wmo = result.unwrap();

    match wmo {
        ParsedWmo::Root(root) => {
            assert_eq!(root.portal_refs.len(), 1);
            assert_eq!(root.portal_refs[0].portal_index, 1);
            assert_eq!(root.portal_refs[0].group_index, 5);
            assert_eq!(root.portal_refs[0].side, 1);
        }
        _ => panic!("Expected root file"),
    }
}

#[test]
fn test_parse_modn_chunk() {
    // MODN contains doodad names (null-terminated M2 filenames)
    let mut buffer = Vec::new();

    // MVER
    write_chunk(&mut buffer, "MVER", &[17, 0, 0, 0]);

    // MOHD with doodad counts
    let mut mohd_data = vec![0u8; 64];
    mohd_data[16..20].copy_from_slice(&3u32.to_le_bytes()); // n_doodad_names = 3
    write_chunk(&mut buffer, "MOHD", &mohd_data);

    // MODN - doodad names
    let mut modn_data = Vec::new();
    modn_data.extend_from_slice(
        b"World\\Kalimdor\\Orgrimmar\\PassiveDoodads\\Braziers\\OrcBrazier.m2\0",
    );
    modn_data.extend_from_slice(b"World\\Generic\\Human\\Passive Doodads\\Furniture\\Chair01.m2\0");
    modn_data.extend_from_slice(b"World\\Generic\\Orc\\Passive Doodads\\Banners\\OrcBanner01.m2\0");

    write_chunk(&mut buffer, "MODN", &modn_data);

    let mut cursor = Cursor::new(buffer);
    let result = parse_wmo(&mut cursor);

    assert!(result.is_ok());
    let wmo = result.unwrap();

    match wmo {
        ParsedWmo::Root(root) => {
            assert_eq!(root.doodad_names.len(), 3);
            assert!(root.doodad_names[0].ends_with("OrcBrazier.m2"));
            assert!(root.doodad_names[1].ends_with("Chair01.m2"));
            assert!(root.doodad_names[2].ends_with("OrcBanner01.m2"));
        }
        _ => panic!("Expected root file"),
    }
}

#[test]
fn test_parse_movv_movb_chunks() {
    // MOVV contains visible block vertices, MOVB contains block definitions
    // These are often empty but we should handle them
    let mut buffer = Vec::new();

    // MVER
    write_chunk(&mut buffer, "MVER", &[17, 0, 0, 0]);

    // MOHD
    let mohd_data = vec![0u8; 64];
    write_chunk(&mut buffer, "MOHD", &mohd_data);

    // MOVV - visible block vertices (empty is common)
    write_chunk(&mut buffer, "MOVV", &[]);

    // MOVB - visible block list (empty is common)
    write_chunk(&mut buffer, "MOVB", &[]);

    let mut cursor = Cursor::new(buffer);
    let result = parse_wmo(&mut cursor);

    assert!(result.is_ok());
    let wmo = result.unwrap();

    match wmo {
        ParsedWmo::Root(root) => {
            assert_eq!(root.visible_vertices.len(), 0);
            assert_eq!(root.visible_blocks.len(), 0);
        }
        _ => panic!("Expected root file"),
    }
}