redguard-preservation 0.6.1

A CLI tool to preserve Redguard 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

use bytemuck::{Pod, Zeroable};

// --- Texture decode output ---

#[derive(Clone, Copy, Pod, Zeroable)]
#[repr(C)]
pub struct TextureHeader {
    pub width: i32,
    pub height: i32,
    pub frame_count: i32,
    pub rgba_size: i32,
}
// 16 bytes, align 4. Followed by `rgba_size` bytes of RGBA pixel data.

#[derive(Clone, Copy, Pod, Zeroable)]
#[repr(C)]
pub struct AllFramesHeader {
    pub width: i32,
    pub height: i32,
    pub frame_count: i32,
}
// 12 bytes, align 4. Followed by `frame_count` frames, each prefixed by an i32 size.

// --- RGMD (model/terrain mesh data) ---

#[derive(Clone, Copy, Pod, Zeroable)]
#[repr(C)]
pub struct RgmdHeader {
    pub magic: [u8; 4],
    pub version: [u8; 4],
    pub submesh_count: i32,
    pub frame_count: i32,
    pub total_vertex_count: i32,
    pub total_index_count: i32,
    pub radius: f32,
}
// 28 bytes, align 4.

#[derive(Clone, Copy, Pod, Zeroable)]
#[repr(C)]
pub struct RgmdSubmeshHeader {
    pub textured: u8,
    pub color_r: u8,
    pub color_g: u8,
    pub color_b: u8,
    pub texture_id: u16,
    pub image_id: u8,
    pub _pad: u8,
    pub vertex_count: i32,
    pub index_count: i32,
}
// 16 bytes, align 4. textured: 0 = solid color (color_r/g/b hold resolved RGB),
// 1 = textured (texture_id + image_id identify the TEXBSI image).

#[derive(Clone, Copy, Pod, Zeroable)]
#[repr(C)]
pub struct RgmdVertex {
    pub position: [f32; 3],
    pub normal: [f32; 3],
    pub uv: [f32; 2],
}
// 32 bytes, align 4. Followed by index_count × u32 indices.

#[derive(Clone, Copy, Pod, Zeroable)]
#[repr(C)]
pub struct RgmdDeltaVertex {
    pub dx: f32,
    pub dy: f32,
    pub dz: f32,
    pub dnx: f32,
    pub dny: f32,
    pub dnz: f32,
}
// 24 bytes, align 4.
// After all base submesh data, frame delta blocks follow:
// For each animation frame: i32 total_delta_count, then per-submesh: i32 delta_count, then delta_count × RgmdDeltaVertex

// --- RGPL (placements + lights) ---

#[derive(Clone, Copy, Pod, Zeroable)]
#[repr(C)]
pub struct RgplHeader {
    pub magic: [u8; 4],
    pub placement_count: i32,
    pub light_count: i32,
}
// 12 bytes, align 4.

#[derive(Clone, Copy, Pod, Zeroable)]
#[repr(C)]
pub struct RgplPlacement {
    pub model_name: [u8; 32],
    pub source_id: [u8; 32],
    pub transform: [f32; 16],
    pub texture_id: u16,
    pub image_id: u8,
    pub object_type: u8,
}
// 132 bytes, align 4. object_type: 0 = mesh, 1 = flat sprite, 2 = rope link.
// texture_id/image_id: TEXBSI texture for flat sprites; 0 for mesh/rope placements.

#[derive(Clone, Copy, Pod, Zeroable)]
#[repr(C)]
pub struct RgplLight {
    pub name: [u8; 32],
    pub color: [f32; 3],
    pub position: [f32; 3],
    pub range: f32,
    pub light_type: u8,
    pub _pad: [u8; 3],
}
// 64 bytes, align 4. light_type: 0 = point. color is linear RGB 0.0–1.0.

// --- ROB (segment archive) ---

#[derive(Clone, Copy, Pod, Zeroable)]
#[repr(C)]
pub struct RobHeader {
    pub segment_count: i32,
}
// 4 bytes, align 4.

#[derive(Clone, Copy, Pod, Zeroable)]
#[repr(C)]
pub struct RobSegmentHeader {
    pub segment_name: [u8; 8],
    pub has_model: u8,
    pub _pad: [u8; 3],
    pub model_data_size: i32,
}
// 16 bytes, align 4. If has_model == 1, followed by model_data_size bytes of RGMD data.

#[derive(Clone, Copy, Pod, Zeroable)]
#[repr(C)]
pub struct RgWorldDescriptor {
    pub world_id: i32,
    pub has_wld: u8,
    pub _pad: [u8; 3],
    pub texbsi_id: u16,
    pub _pad2: [u8; 2],
    pub rgm_path: [u8; 64],
    pub wld_path: [u8; 64],
    pub palette_path: [u8; 64],
}
// 204 bytes, align 4. Paths are null-terminated ASCII, zero-padded.