prtgn_encoding 0.1.1

Encoding and decoding for the PRTGN file format
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

# PRTGN Encoding


A Rust library for encoding PRTGN files. 


> [!CAUTION]
> 
>PRTGN Encoding, a Rust library for encoding PRTGN files. For use in programs relating to https://github.com/PRTGN-Development-Team/.prtgn
>Copyright (C) 2025 PRTGN Development Team
>
>This program is free software: you can redistribute it and/or modify
>it under the terms of the GNU General Public License as published by
>the Free Software Foundation, either version 3 of the License, or
>(at your option) any later version.
>
>This program is distributed in the hope that it will be useful,
>but WITHOUT ANY WARRANTY; without even the implied warranty of
>MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>GNU General Public License for more details.
>
>You should have received a copy of the GNU General Public License
>along with this program.  If not, see <https://www.gnu.org/licenses/>.

## Basic Usage


### Implementing


Add one of the following lines to Cargo.toml

Github :
```toml
prtgn_encoding = { git = "https://github.com/PRTGN-Development-Team/PRTGN_encoding" }
```

Crates.io :
```toml
prtgn_encoding = "<newest version>"
```

### Write


```rust
use prtgn_encoding::write;

fn main() {
    
    let filename = "test.prtgn".to_string();
    let text = "Hello world! This is some example text.".to_string();
    
    write(filename, text).unwrap();
}
```

### Read


```rust
use prtgn_encoding::read;

fn main() {
    
    let filename = "test.prtgn".to_string();

    let read_text = read(filename).unwrap().to_string();
}
```