diff --git a/README.md b/README.md index d3135b1..c5d08a2 100644 --- a/README.md +++ b/README.md @@ -3,19 +3,20 @@ Extract audio from .pck and .hdiff to mp3 with this tool. It can in theory extra # 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. Download the [`tools.zip`](https://github.com/Escartem/AnimeWwise/releases/latest/download/tools.zip) (or on the release page) and place it in the same folder as the project, this is to save up repo size when updating the tools -> ℹ️ The zip file will be automatically extracted on first launch, it just needs to be here -> -> ⚠️ Make sure to always use the latest tools and the latest project version to prevent errors -> -> ⚠️ Your browser may flag the zip file as malicious, I don't have a solution right now, just ignore the message and download it anyway -4. Install dependencies -> `pip install -r requirements.txt` -5. Place all of your `.pck` files in the *audio* folder and `.pck.hdiff` in the *patch* folder +1. Get the repo by [downloading it](https://github.com/Escartem/WwiseExtract/archive/refs/heads/master.zip) or cloning it (`git clone https://github.com/Escartem/WwiseExtract`) +> ℹ️ This project uses ffmpeg version *3.4.2* which is the latest under 50Mb. But it is also slower, if you want to slightly improve extraction speed, consider updating the ffmpeg binary to a [newer version](https://github.com/BtbN/FFmpeg-Builds/releases) +2. Install dependencies -> `pip install -r requirements.txt` +3. Place all of your `.pck` files in the *audio* folder and `.pck.hdiff` in the *patch* folder > ⚠️ If you want to extract an hdiff content, you must place the pck file with the *same name before patch* in the *audio* 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) --- +# New features + +## There is a separate branch called `dev` that may includes new features, you can check it out if you want to get them early + +--- + ### And that's pretty much it, if you have any issue, suggestion or anything just open an issue or create a pr :)