libsts 0.3.1

A library for working with Slay the Spire save and run 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

# libsts


libsts is a Rust library for working with Slay the Spire save and run files.

* [API Documentation](https://docs.rs/libsts/)
* Cargo package: [libsts](https://crates.io/crates/libsts)
* [Mega Crit](https://www.megacrit.com/), the creators of Slay the Spire

---
## Installation


Add this to your `Cargo.toml`:

```toml
[dependencies]
libsts = "0.3"
```

## Basic Usage


```rust
use libsts::{Save, SaveError};
use std::fs;

fn main() {
    // Load the Ironclad save file
    let contents = fs::read_to_string("IRONCLAD.autosave").unwrap();
    
    // Attempt to parse the save file
    if let Ok(mut save) = Save::new(&contents) {
        // Increase the player's hand size and gold
        save.hand_size += 2;
        save.gold += 999;
        
        // Get the base64 string representation of our modified savefile
        if let Ok(modified_save) = save.to_b64_string() {
            // Attempt to overwrite the current save file
            // with our modified cheaty save file
            fs::write("IRONCLAD.autosave", modified_save); 
        }
        
        // Or if you're using the BETA branch of STS:
        if let Ok(modified_save) = save.to_string() {
            // ...
            fs::write("IRONCLAD.autosaveBETA", modified_save);
        }
    }
}
```
### License

Licensed under either of
 * Apache License, Version 2.0
   ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license
   ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.