diff --git a/.gitignore b/.gitignore index f949d1f..7d36c1a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ /target /.idea -/release \ No newline at end of file +/release +rip \ No newline at end of file diff --git a/Cargo.lock b/Cargo.lock index 9ec8608..3767f66 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4,4 +4,4 @@ version = 3 [[package]] name = "rip" -version = "0.1.0" +version = "0.3.0" diff --git a/Cargo.toml b/Cargo.toml index b1fe8fe..84a5e29 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,8 @@ [package] name = "rip" -version = "0.1.0" +version = "0.3.0" edition = "2021" +authors = ["Kasyanov Nikolay Alexeyevich (Unbewohnte)"] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/README.md b/README.md new file mode 100644 index 0000000..e7a61f7 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# RIP +## various embedded content + +# Use +`rip -h` will print out this help message + +` +rip (optional)[FLAG]... (optional; default=ALL)[RIPTYPE] [FILE]... + + +[FLAG]s +"-v" or "--version" -> print version +"-h" or "--help" -> print this message +"-sd" or "--save-dir" [DIR] -> specify save directory +"-mfs" or "--max-file-size" [SIZE] -> skip files bigger than size (in bytes) + + +[RIPTYPE] +ALL -> rip everything that seems like an embedded content +IMG -> try to look for images only +AUDIO -> rip audio content +` + +### Examples +- `rip audio music/*` -> extract found audio data from all files in music directory +- `rip -sd extracted img game_with_cool_sprites.exe` -> get image data from `game_with_cool_sprites.exe` and save it to `extracted` folder +- `rip -mfs 52428800 all various_files/*` -> rip everything from files that are under 50MB +- `rip all various_files/file1.data various_files/file2.xp3` -> rip everything from file1.data and file2.xp3 + +# Compile +As usual - `cargo build --release` or simply `make all` if you have it. + +RIP has no dependencies and never will so no Internet connection needed in order to build it + +# License +RIP is under GPLv3 \ No newline at end of file