pak 0.5.0

An easy-to-use data pak format for games.
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

# `.pak` Asset Crate

[![Crates.io](https://img.shields.io/crates/v/pak.svg)](https://crates.io/crates/pak)
[![Docs.rs](https://docs.rs/pak/badge.svg)](https://docs.rs/pak)

## `.pak` Configuration File

Each asset package is "baked" from a configuration source file. _Example:_

_Rust code_

```rust
PakBuf::bake("game_art.toml", "game_art.pak")?;
```

_`game_art.toml`_

```toml
[content]
compression = 'snap'

[[content.group]]
assets = [
    'bitmap/**/*.png',
    'font/**/*.toml',
    'model/**/*.toml',
    'sound/**/*.ogg',
    'music/*.mp3',
    'ui/*.png',
]
```

_Note:_

Additional `[[content.group]]` tables may be appended. All groups are added to the package and these
individual groups are not distinct entities in the runtime file.

_`[content]` Schema_

Item | Description
---- | -----------
compression | May be omitted, `'snap'` or `'x'`

## 3D Models



_Example:_

```toml
[model]
src = "some_file.gltf"

```

_`[model]` Schema_

Item | Description
---- | -----------
`src` | File path to the `.gltf` or `.glb` model file. May be relative to the `[model]` TOML file or absolute where the root is the same folder as the `[content]` TOML file.

## Tests

Run tests with all features in order to include the baking code:

```bash
cargo test --all-features
```