rpgcpf 0.1.1

GCPF archive compression and decompression library
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

# rpgcpf

⚠️ this is alpha quality software! there may be some [unknown bugs](#contributing)! ⚠️

rpgcpf is a rust library and command line tool for compressing and decompressing godot compressed packed format (GCPF) files.

This repository contains a [rust library](#rpgcpf) and a [command line application](#rpgcpf-cli).

## features

- compressing a file to the GCPF format
- decompressing GCPF files
- supports all five compression modes used by GCPF: brotli, deflate, fastlz, gzip, and zstd
- rust library
- command line tool

## rpgcpf cli

The `rpgcpf` cli tool decompresses GCPF files, and compresses uncompressed files to the GCPF format.

```
Usage: rpgcpf <COMMAND>

Commands:
  pack    Compress an input to an output
  unpack  Decompress an input to an output
  info    Show info and statistics about an input
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version
```

### installation

for now rpgcpf is only available through cargo, but there are plans to package it for distribution through other package managers when it's more stable.

```
cargo install rpgcpf
```

## rpgcpf

`rpgcpf` is a rust library implementing GCPF compression in decompression. It supports the brotli, deflate, fastlz, gzip, and zstd compression modes.

You can read the crate documentation at <https://docs.rs/rpgcpf/latest/rpgcpf/>

Decompression example:

```rust
use rpgcpf::Gcpf;

let data: &[u8] = /* ... */;
let mut uncompressed = Gcpf::read(data)
    .unwrap()
    .decompress()
    .unwrap()
```

Compression example:

```rust
use rpgcpf::{CompressionMode, Gcpf};

let data: &[u8] = /* ... */;
let mut compressed = Gcpf::compress(data, CompressionMode::Zstd).unwrap();
```

### installation

rpgcpf is available on crates.io

```
cargo add rpgcpf
```

### cargo features

rpgcpf uses cargo features to enable or disable compression modes at compile time. these features are:

- `brotli`: enables the brotli comression mode, depends on the `brotli` crate
- `deflate`: enables the deflate comression mode, depends on the `flate2` crate
- `fastlz`: enables the fastlz comression mode, depends on the `fastlz-rs` crate
- `gzip`: enables the gzip comression mode, depends on the `flate2` crate
- `zstd`: enables the zstd comression mode, depends on the `zstd` crate
- `cli`: enables the command line binary, and adds `clap` derives to the `Gcpf` struct. Depends on the `clap`, `patharg`, `anyhow`, and `humanize-bytes` crates

the `default` features are: `["brotli", deflate", "fastlz", "gzip", "zstd", "cli"]`

## contributing

TODO

## License

This work is marked with [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/). Read the [LICENSE](./LICENSE) file for details.

Thanks for not using this code to train an LLM or machine learning model :)