From 4d379aa3b8d7272ca46372f7b0cf497dae2ac361 Mon Sep 17 00:00:00 2001 From: dece Date: Sat, 23 May 2020 00:51:45 +0200 Subject: [PATCH] readme: update with param/paramdef --- README.md | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5e0bede..07a1daa 100644 --- a/README.md +++ b/README.md @@ -36,13 +36,15 @@ FLAGS: -V, --version Prints version information SUBCOMMANDS: - bhd Extracts BHD/BDT contents - bhds Extracts all BHD/BDT content (alphabetically) in a folder - bhf Extracts BHF/BDT contents - bnd Extracts BND contents - dcx Extracts and decompress DCX data - hash Calculates hash for a string - help Prints this message or the help of the given subcommand(s) + bhd Extracts BHD/BDT contents + bhds Extracts all BHD/BDT content (alphabetically) in a folder + bhf Extracts BHF/BDT contents + bnd Extracts BND contents + dcx Extracts and decompress DCX data + hash Calculates hash for a string + help Prints this message or the help of the given subcommand(s) + param Parses PARAM contents + paramdef Prints PARAMDEF contents ``` @@ -50,6 +52,8 @@ SUBCOMMANDS: Features -------- +### Containers + - BHD5 / BDT: extraction from disk to disk. - DCX: decompression from disk to disk/memory. - BND (v3): extraction from disk/memory to disk/memory, optionally decompress @@ -64,6 +68,15 @@ Repacking is not supported, maybe one day. It is not that useful when using [yabber]: https://github.com/JKAnderson/Yabber [sieglib]: https://github.com/Dece/DarkSoulsDev/tree/master/Programs/SiegLib +### Files + +- PARAMDEF: parsing +- PARAM: parsing, optionally with a PARAMDEF + +### Misc + +- Encrypted archive name hasher. + There is a demo Python binding for some `name_hashes` features in the `bindings/python` dir, that uses [PyO3][pyo3] and thus requires nightly rustc to build.