Version 2.0.0

Author: savannstm

.cargo/config.toml

@@ -0,0 +1,5 @@
+[build]
+rustflags = [
+    "-C", "target-feature=+aes,+sse2",
+    "-C", "target-feature=+crt-static",
+]

Cargo.toml

@@ -1,18 +1,18 @@
 [package]
 name = "rpgmad-lib"
-version = "1.0.2"
+version = "2.0.0"
 authors = ["savannstm <savannstm@gmail.com>"]
 edition = "2021"
 rust-version = "1.60.0"
-description = "A decrypter implementation for rpgm-archive-decrypter. Not intended for use in other applications; but can be."
+description = "Library for decrypting RPG Maker `rgss` archives."
 readme = "README.md"
 repository = "https://github.com/savannstm/rpgm-archive-decrypter-lib"
 documentation = "https://docs.rs/rpgmad-lib"
 license-file = "LICENSE.md"
 
-[features]
-rayon = ["dep:rayon"]
-
 [dependencies]
-arrayvec = "0.7.6"
-rayon = { version = "1.10.0", optional = true }
+thiserror = "1.0.65"
+
+[dev-dependencies]
+marshal-rs = "0.4.0"
+png = "0.17.16"

README.md

@@ -1,16 +1,26 @@
 # rpgm-archive-decrypter-lib
 
-A decrypter implementation for [rpgm-archive-decrypter](https://github.com/savannstm/rpgm-archive-decrypter).
-Not intended for use in other applications; but can be.
+Library for decrypting RPG Maker `rgss` archives.
 
-## Quick example
+Used in [rpgm-archive-decrypter](https://github.com/savannstm/rpgm-archive-decrypter).
+
+## Example
 
 ```rust
-let archive_bytes = std::fs::read("C:/Documents/Game/Game.rgssad");
-let mut decrypter = rpgmad_lib::Decrypter::new();
+use rpgmad_lib::{Decrypter, extract_archive};
+
+// Using Decrypter struct
+let archive_content: Vec<u8> = std::fs::read("C:/Game/Game.rgss3a").unwrap();
+let mut decrypter = Decrypter::new();
+
+// You can optionally set force
+// decrypter.set_force(true)
+
+decrypter.extract(&archive_content, "C:/Game").unwrap();
 
-// Writes decrypted game files to "C:/Documents/Game"
-decrypter.extract("C:/Documents/Game", false).unwrap()
+// Using function
+// let force = false; // When `true`, it will overwrite existing files in the game directory.
+// extract_archive(&archive_content, "C:/Game", force).unwrap();
 ```
 
 ## License

examples/example.rs

@@ -0,0 +1,16 @@
+use rpgmad_lib::{extract_archive, Decrypter};
+
+fn main() {
+    // Using Decrypter struct
+    let archive_content: Vec<u8> = std::fs::read("C:/Game/Game.rgss3a").unwrap();
+    let mut decrypter = Decrypter::new();
+
+    // You can optionally set force
+    // decrypter.set_force(true)
+
+    decrypter.extract(&archive_content, "C:/Game").unwrap();
+
+    // Using function
+    let force = false; // When `true`, it will overwrite existing files in the game directory.
+    extract_archive(&archive_content, "C:/Game", force).unwrap();
+}

rustfmt.toml

@@ -0,0 +1 @@
+line_width = 80