1

Updating README

This commit is contained in:
Alex Yatskov 2015-07-09 17:08:49 +09:00
parent 788d7b87ec
commit 5d277b1942

View File

@ -1,4 +1,4 @@
# hlm2-wad-extract # HLM2-Wad-Extract #
This application is a tool to extract the asset data used in the newly released [Hotline Miami 2: Wrong This application is a tool to extract the asset data used in the newly released [Hotline Miami 2: Wrong
Humber](https://en.wikipedia.org/wiki/Hotline_Miami_2:_Wrong_Number) game. You can download or clone the latest version Humber](https://en.wikipedia.org/wiki/Hotline_Miami_2:_Wrong_Number) game. You can download or clone the latest version
@ -11,11 +11,12 @@ directory as it was in the preceding game. Seeing as I had some free time, I de
files myself out of the accompanying game WAD pack files. The file format turned out to be really simple and easy to 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. understand, so I wrote a small Python utility to extract some or all of the game data.
## Usage Instructions ## Usage Instructions ##
This script makes it trivial to extract game data from the WAD files shipped with the game (currently 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 `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 is under `~/.steam/steam/steamapps/common/Hotline Miami 2` (probably in a similar location on other platforms).
Assuming that you have [Python 2.7](https://www.python.org/download/releases/2.7/) installed, you can execute the 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: `extract.py` script with the `-h` option for a description of available options:
@ -36,7 +37,9 @@ optional arguments:
For example, in order to extract the game's music files only, you could execute the following command: For example, in order to extract the game's music files only, you could execute the following command:
`./parse.py --pattern "*.ogg" hlm2_data_desktop.wad` ```
$ ./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 While I expect this utility to be trivial for all to use, let me know if you encounter any difficulties or unexpected
behavior. behavior.