
		SoCPUP version 1.0

SoCPUP (Shadow of Chernobyl Patcher/Unpacker/Packer) is 
a subset of bardak's X-ray Assets converter toolset, 
specifically the database unpacker and packer portion, 
adapted by me (NatVac) for use with batch files and 
extended to include a file patcher.

Enhancements include the ability to extract individual 
archive directories or files and the display of more 
progress info.

The file patcher is currently in a preliminary state.  It 
relies on a patch file of commands that tell SoCPUP what 
file to load and how to patch it.  This is an early form 
of what is intended, provided to allow the patching of the 
Pripyat level data to eliminate ghost garages.

See _PripyatLevelFix_readme.txt to find out how to patch 
the Pripyat level for your STALKER SoC game.

The following is excerpted from docs\overview_en.txt and
docs\converter_en.txt, adapted to suit SocPUP.  The info
in this document takes precedence over those docs.

---------------------------------------------------------
[Introduction]
SoCPUP 1.0 implements the following functions:
 - game archive packing/unpacking
 - limited file patching

SoCPUP is a console application (Start -> Run -> cmd.exe).

[Installation]
It is strongly recommended to use the -ro option 
(operation without any writing to disk) after any 
batch file or configuration changes.

[Game archive packing/unpacking]
Command line to unpack:
 SoCPUP -unpack <archive> [-1114|-2215|-2945|-2947ru|-2947ww|-xdb]

Command line to pack:
 SoCPUP -pack <folder> [-2947ru|-2947ww|-xdb]

[File patching]
Command line to patch:
 SoCPUP -patchfile <patchfile>

You can see a brief summary of the commands by typing 
SoCPUP in a console window (AKA command-line interface or 
CLI, command shell and MS-DOS window).

For more details on the use and operation of SoCPUP, see 
SoCPUP_Manual.txt.

---------------------------------------------------------
[Licensing]
The unofficial toolset subset uses third-party code:
 - Most matrix/quaternion methods are taken from
   Game Programming Gems (http://www.graphicsgems.org),
   WildMagic library (http://www.geometrictools.com),
   LightWave 8.0 SDK and ik2Bsolver sample from Maya 8.5 SDK.
   NOTE:  This code is not really used in SoCPUP, but I've
   not yet cleaned up the code enough to remove the files.
 - lzhuf.c (Haruyasu Yoshizaki)
 - minilzo library (http://www.oberhumer.com/opensource/lzo/)
 - CRC32 (Gary S. Brown)

The code to load/save X-Ray files closely follows the GSC one.

Regarding the rest of the source code, you can do whatever you 
want, just do not say you wrote it. Please include this notice 
and all the source code when distributing the executable(s).


[Content]
SoCPUP.exe - database unpacker/packer, file patcher.
_PripyatLevelFix.bat and _PripyatLevelFix.patch files.
Source code to build SoCPUP.exe.

[Installation -- general]
PC with SSE-capable CPU and 2GB RAM.

The program was built using the TDM-GCC version of MinGW, 
version 4.5.1 (32 bit).  See http://tdm-gcc.tdragon.net/ 
for details, or you can just use MinGW, available via 
SourceForge.

It has been tested to run on Windows XP SP2 and should run 
on later versions of Windows.  It should not need any extra 
runtime support beyond that which comes with Windows.
