11# rpgm-archive-decrypter
22
3- RPGM Archive Decrypter is a [ RPG Maker Decrypter] ( github.com/uuksu/rpgmakerdecrypter ) rewrite in Rust (** _ BLAZINGLY FAST_ ** :fire : ).
4- It can be used to extract encrypted archives of RPG Maker XP/VX/VXAce game engines, and generate project files for decrypted data .
3+ RPGM Archive Decrypter is a [ RPG Maker Decrypter] ( https:// github.com/uuksu/rpgmakerdecrypter) rewrite in Rust (** _ BLAZINGLY FAST_ ** :fire : ).
4+ It can be used to extract encrypted archives of RPG Maker XP/VX/VXAce game engines.
55It is faster and lighter than RPG Maker Decrypter, and also has ** NO** requirements to run, except a working PC.
66
77_ And also features much more cleaner code!_
@@ -13,10 +13,22 @@ One with `.exe` extension is for Windows, without it - is for Linux.
1313
1414## Usage
1515
16- Call ` rpgmad.exe -h ` for help.
16+ Call ` rpgmad -h ` for help.
1717
1818``` text
19-
19+ A tool to extract encrypted .rgss RPG Maker archives.
20+
21+ Usage: rpgmad.exe [OPTIONS]
22+
23+ Options:
24+ -i, --input-file <input-path>
25+ Path to the RGSSAD file. [default: ./]
26+ -o, --output-dir <output-path>
27+ Path to put output files. [default: ./]
28+ -f, --force
29+ Forcefully overwrite existing Data, Graphics and other files.
30+ -h, --help
31+ Prints the help message.
2032```
2133
2234For example, to extract archive to same same directory where it exists:
@@ -26,13 +38,24 @@ You can recongnize archives by their extensions: `rgssad`, `rgss2a`, `rgss3a`.
2638
2739## GUI
2840
29- Full-featured GTK GUI built with ` gtk-rs ` is in progress.
41+ Full-featured GUI will maybe come out someday. Not sure in a relevancy.
42+
43+ ## Development
3044
31- ## Building
45+ ### Building
3246
3347Requirements: ` rustup ` with installed Rust toolchain, linker (` gcc ` , ` llvm ` or ` msvc ` ).
3448
35- Clone the repository with ` git ` and compile with ` cargo b -r ` .
49+ Clone the repository and compile with ` cargo b -r ` .
50+
51+ ### Tests
52+
53+ I'm not really skilled in tests, but the validity of output files is tested the following ways:
54+
55+ - Of images, using image viewers.
56+ - Of rx/rvdata files, using [ rvpacker-txt-rs] ( https://github.com/savannstm/rvpacker-txt-rs ) .
57+
58+ As long as these tests succesful, there shouldn't be any bugs.
3659
3760## License
3861
0 commit comments