fable_format 0.1.1

A Rust library for using the assets of Fable, Fable: The Lost Chapters, Fable Anniversary, and mods.
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

mod decode;
mod encode;

use chrono::naive::NaiveDateTime;

/// The world archive.
///
/// These archives contain only [`Lev`] and [`Tng`] files. Usually there's only one occurence at `Data/Levels/FinalAlbion.wad`.
///
/// See [`WadReader`] to read the archive. You read the archive with [`WadHeader`] to find the entries, and each [`WadEntry`] to find the file contents.
///
/// ## Format Description
///
/// | Section | Description                                                  |
/// |---------|--------------------------------------------------------------|
/// | Header  | The [`WadHeader`].                                           |
/// | Blob    | The file contents in contiguous chunks.                      |
/// | Entries | The list of [`WadEntry`] with metdata and content locations. |
///
/// See those structs for more details.
///
/// [`WadHeader`]: ./struct.WadHeader.html
/// [`WadEntry`]: ./struct.WadEntry.html
/// [`WadReader`]: ./struct.WadReader.html
/// [`Lev`]: ../struct.Lev.html
/// [`Tng`]: ../struct.Tng.html
/// [`WadReader`]: ../struct.WadReader.html
#[derive(Debug,PartialEq)]
pub struct Wad {
    pub header: WadHeader,
    pub entries: Vec<WadEntry>
}

/// A Wad header used for finding the start and end of the entry section.
///
/// ## Format Description
///
/// | Field                  | Type        | Byte Size | Description                     |
/// |------------------------|-------------|-----------|---------------------------------|
/// | Magic number           | `[4; char]` | 4         | `"BBBB"` string.                |
/// | Version                | `[3; u32]`  | 12        | File version number.            |
/// | Block size             | `u32`       | 4         | Chunk size. Usually `2048`.     |
/// | Entry count            | `u32`       | 4         | Amount of entries.              |
/// | Entry count repeated   | `u32`       | 4         |                                 |
/// | First entry offset     | `u32`       | 4         | Offset to the first entry .     |
#[derive(Debug,PartialEq)]
pub struct WadHeader {
    pub version: (u32, u32, u32),
    pub block_size: u32,
    pub entries_count: u32,
    pub entries_offset: u32,
}

/// A Wad entry with a file's metadata and the location of its contents.
///
/// ## Format Description
///
/// The entries start at the header's first entry offset and are repeated until the entry count.
///
/// | Field       | Type       | Byte Size | Description                                      |
/// |-------------|------------|-----------|--------------------------------------------------|
/// | Unknown     | `[16; u8]` | 16        | (Maybe hash-related.)                            |
/// | File Id     | `u32`      | 4         | Index number. (This is implicit tho lol?)        |
/// | Unknown     | `u32`      | 4         |                                                  |
/// | File size   | `u32`      | 4         | File size in the blob.                           |
/// | File offset | `u32`      | 4         | File offset in the blob.                         |
/// | Unknown     | `u32`      | 4         |                                                  |
/// | Path size   | `u32`      | 4         | Size of the path string that follows.            |
/// | Path string | `String`   | Path size | File path                                        |
/// | Unknown     | `[16; u8]` | 16        | (Maybe some kind of metadata like perms.)        |
/// | Created     | `[7; u32]` | 28        | Creation timestamp.                              |
/// | Accessed    | `[7; u32]` | 28        | Access timestamp.                                |
/// | Written     | `[5; u32]` | 20        | Write timestamp.                                 |
///
/// ### Timestamps
///
/// This is a description for the "created at" and "accessed at" fields. The "written at" field is similar but only percise to minutes.
///
/// | Field       | Type  | Byte Size |
/// |-------------|-------|-----------|
/// | Year        | `u32` | 4         |
/// | Month       | `u32` | 4         |
/// | Day         | `u32` | 4         |
/// | Hour        | `u32` | 4         |
/// | Minute      | `u32` | 4         |
/// | Second      | `u32` | 4         |
/// | Millisecond | `u32` | 4         |
#[derive(Debug,PartialEq)]
pub struct WadEntry {
    pub id: u32,
    pub offset: u32,
    pub length: u32,
    pub path: String,
    pub created: NaiveDateTime,
    pub accessed: NaiveDateTime,
    pub written: NaiveDateTime,
}