📓 Improve documentation

This commit is contained in:
C-3PO 2018-09-30 16:09:51 +02:00
parent 6bd7d47fc0
commit 132c36835f
Signed by: c3po
GPG key ID: 62993C4BB4D86F24
2 changed files with 7 additions and 4 deletions

View file

@ -1,6 +1,6 @@
```patch-installer``` is a command-line application that can be used to extract a single file from the disk files (.z01, .z02 etc.). This tool is very low-level and assumes that you have already read the .zip file and know the location, size and decryption keys of the specific file you want to extract. `patch-installer` is a command-line application that can be used to extract a single file from the disk files (.z01, .z02 etc.). This tool is very low-level and assumes that you have already read the .zip file and know the location, size and decryption keys of the specific file you want to extract.
If this is not a ```-1to0``` patch, the disk file may only contain the differences to the previous release. In this case, you can supply the location of this file's previous version, and this tool will generate the new version using VCDIFF/xdelta3. If this is not a `-1to0` patch, the disk file may only contain the differences to the previous release. In this case, you can supply the location of this file's previous version, and this tool will generate the new version using VCDIFF/xdelta3.
If a target location is specified, the extracted file is saved to that location, otherwise it is written to stdout. From there, you can either dump it to disk or process it in memory. If a target location is specified, the extracted file is saved to that location, otherwise it is written to stdout. From there, you can either dump it to disk or process it in memory.
@ -8,19 +8,21 @@ If a target location is specified, the extracted file is saved to that location,
To compile: To compile:
``` ```bash
./build.sh ./build.sh
``` ```
To use: To use:
``` ```bash
wget http://cdn-patch.swtor.com/patch/assets_swtor_main/assets_swtor_main_-1to0/assets_swtor_main_-1to0.z08 && wget http://cdn-patch.swtor.com/patch/assets_swtor_main/assets_swtor_main_-1to0/assets_swtor_main_-1to0.z08 &&
./patch-installer --disk assets_swtor_main_-1to0.z08 --offset 267071107 --size 165738618 --keys 3393608425,2820264972,3930508185 > ../swtor_main_gfx_1.tor && ./patch-installer --disk assets_swtor_main_-1to0.z08 --offset 267071107 --size 165738618 --keys 3393608425,2820264972,3930508185 > ../swtor_main_gfx_1.tor &&
stat swtor_main_gfx_1.tor stat swtor_main_gfx_1.tor
rm assets_swtor_main_-1to0.z08 rm assets_swtor_main_-1to0.z08
``` ```
For a description of the command line arguments, see `src/errorAndExit.c`.
# Dependencies # Dependencies
## Miniz <[https://github.com/richgel999/miniz](https://github.com/richgel999/miniz)> ## Miniz <[https://github.com/richgel999/miniz](https://github.com/richgel999/miniz)>

View file

@ -9,6 +9,7 @@
//Uses GNU's getopt_long_only(), see https://www.gnu.org/software/libc/manual/html_node/Getopt-Long-Options.html //Uses GNU's getopt_long_only(), see https://www.gnu.org/software/libc/manual/html_node/Getopt-Long-Options.html
//For a description of these arguments, see errorAndExit.c
static struct option long_options[] = { static struct option long_options[] = {
{"disk", required_argument, 0, 'd'}, {"disk", required_argument, 0, 'd'},
{"offset", required_argument, 0, 'o'}, {"offset", required_argument, 0, 'o'},