REWise/rewise.1

.TH rewise 1 "20 May 2023" "version 0.1.0" 

.SH NAME
.B rewise
- Extract files from Wise installers without executing them.


.SH SYNOPSIS
.B rewise
.RB OPERATION
.RB [OPTIONS]
.RB INPUT_FILE


.SH DESCRIPTION
.B rewise
Reverse Engineering Wise - The aim of this project is to extract assets from
old game installers made with Wise installer without executing the PE file
(.exe), so they can be used with free software implementations of the game
engine.

The known working Wise installers are released from 1999 to 2003, the PE build
date of those installers are between 1998 and 2001.


.SH OPERATION
Specifying an OPERATION is mandatory. Exactly one operation is allowed per
execution.

All files that REWise does output will be overwritten when they exist!

.TP
.B -x --extract <OUTPUT_PATH>
Extract files. Existing files in the OUTPUT_PATH will be overwritten!

.TP
.B -r --raw <OUTPUT_PATH>
Extract all files in the overlay data. This does not move/rename files! The
extra files are files only used by the installer and would not be installed
normally. This operation is for debugging purposes. Existing files in the
OUTPUT_PATH will be overwritten!

.TP
.B -l --list
This will list all files that would be installed by the installer, TMP
installer files are not listed. It will also print the total size of the listed
files at the end.

.TP
.B -V --verify
Run extract without actually outputting files, CRC32s will be checked.

.TP
.B -Z --script-debug
Print parsed WiseScript.bin

.TP
.B -v --version
Print version and exit.

.TP
.B -h --help
Print help and exit.


.SH OPTIONS
.TP
.B -p --preserve
Don't try to delete TMP files at TMP_PATH.

.TP
.B -t --tmp-path <TMP_PATH>
Set temporary path. Run `rewise --help` to find the default TMP_PATH (it should
be in the description of -t --tmp-path).

.TP
.B -d --debug
Print debug info.

.TP
.B -s --silent
Be silent, don't print anything.

.TP
.B -n --no-extract
Don't extract anything. This will be ignored with -x or -r. It also will not
try to remove TMP files, so -p won't do anything. WiseScript.bin should exist
at the TMP_PATH. The use case for this is to use a WiseScript.bin at given
TMP_PATH with the use of -Z --script-debug or to test extracting with a custom
WiseScript.bin.


.SH INPUT_FILE
The Wise installer file (.exe), this is is mandatory. A relative path is
allowed and will be resolved.


.SH EXIT STATUS
The exit status is 0 on success, greater then zero on error.


.SH NOTES
.IP \[bu] 2
Path to directory OUTPUT_PATH and TMP_PATH should exist, be writable and
of-course there should be enough free-space. There should be at-least 1 MiB of
free-space at the TMP_PATH, for the OUTPUT_PATH with the use of --extract you
can use --list fist to determine the required free-space. Relative paths are
allowed and will be resolved.

.IP \[bu]
REWise is only tested on Little Endian systems. Did you try REWise on a Big-
Endian system then please report your results by opening a new issue at
<https://notabug.org/CYBERDEViL/REWise/issues/>

.IP \[bu]
REWise will not delete/cleanup extracted files when the process fails somehow,
TMP files however will be deleted unless --preserve is given.


.SH EXAMPLES
.B Extracting files as the installer would have:
.RS 2
rewise -x /path/to/extract/files/to/ /path/to/Setup.exe
.RE

.B List files:
.RS 2
rewise -l /path/to/Setup.exe
.RE


.SH LICENSE
REWise is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

REWise is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.


.SH BUGS
For known issues and reporting new issues: see
<https://notabug.org/CYBERDEViL/REWise/issues/>.


.SH HOMEPAGE
https://notabug.org/CYBERDEViL/REWise