diff --git a/README.md b/README.md index 04f5537..51fa5e3 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,19 @@ # HLM2-Wad-Extract # -This application extracts asset data packaged with the newly released [Hotline Miami 2: Wrong -Humber](https://en.wikipedia.org/wiki/Hotline_Miami_2:_Wrong_Number) game. Although it was developed on Linux to run on -Linux, it should work on other platforms without any modification. +This tool extracts binary asset data (including the soundtrack in OGG format) packaged with [Hotline Miami 2: Wrong +Humber](https://en.wikipedia.org/wiki/Hotline_Miami_2:_Wrong_Number). -## Motivation ## +## Dependencies ## -After purchasing and thoroughly enjoying this title, I thought that I would like to listen to the excellent soundtrack -while coding. I was slightly disappointed when I discovered that the music data was not simply included in the install -directory as it was in the preceding game. Seeing as I had some free time, I decided to try to fish out the music OGG -files myself out of the accompanying game WAD pack files. The file format turned out to be really simple and easy to -understand, so I wrote a small Python utility to extract some or all of the game data. +* [Python 2.7](https://www.python.org/download/releases/2.7/) ## Usage ## -This script makes it trivial to extract game data from the WAD files shipped with the game (currently -`hlm2_data_desktop.wad` and `hlm2_patch_desktop.wad`). These files can be found in the game install directory; on Linux -this is under `~/.steam/steam/steamapps/common/Hotline Miami 2` (probably in a similar location on other platforms). +This application extracts asset data from the WAD files that are shipped with the game (currently +`hlm2_data_desktop.wad` and `hlm2_patch_desktop.wad`). These files can be found in the game install path; on Linux, this +is the `~/.steam/steam/steamapps/common/Hotline Miami 2` directory. -Assuming that you have [Python 2.7](https://www.python.org/download/releases/2.7/) installed, you can execute the -`extract.py` script with the `-h` option for a description of available options: +Execute `extract.py` script with the `-h` option for a description of available options: ``` usage: parse.py [-h] [--pattern PATTERN] [--output DIRECTORY] @@ -42,9 +36,6 @@ For example, in order to extract the game's music files only, you could execute $ ./parse.py --pattern "*.ogg" hlm2_data_desktop.wad ``` -While I expect this utility to be trivial for all to use, let me know if you encounter any difficulties or unexpected -behavior. - ## License ## MIT