diff --git a/README.md b/README.md index 03aaadf..b59ac89 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ # WwiseExtract -Extract audio from .pck and .hdiff to mp3 (Originally for Genshin Impact) +Extract audio from .pck and .hdiff to mp3 with this tool. It can in theory extract any pck or hdiff file from any game even though it was made for Genshin Impact. There are others tools that do the same but none of them were working so I just made my own. + +# Usage + +1. Get repo by cloning it -> `git clone https://github.com/Escartem/WwiseExtract` or [downloading it](https://github.com/Escartem/WwiseExtract/archive/refs/heads/master.zip) +2. Install dependencies -> `pip install -r requirements.txt` +3. Place all of your `.pck` files in the *original* folder and `.pck.hdiff` in the *hdiff* folder +> ⚠️ If you want to extract an hdiff content, you must place the pck file with the same name before patch in the original folder, pck's that do not have a corresponding hdiff file will be extracted normally, when they do have a corresponding hdiff file, only the hdiff file content is extracted and not the full pck +4. Start the program -> `python extract.py` +5. After finishing, everything will be in the *output* folder in the mp3 format (ogg may be added later) + +--- + +### And that's pretty much it, if you have any issue, suggestion or anything just open an issue or create a pr :)