Readme.UnrPack.txt
=====================================================================================================
The file you have just downloaded is a fully free packing utility for Unreal mappers. Although there
are many general packing utilities, none of them are well suited for packing Unreal files.

This application has some properties that will make the file packing easy - and it also lacks
many features that are useless for an Unreal mapper.


Main features:
=====================================================================================================
- very easy to install
- very easy to use
- automatic detection of UT and UT2003 installations
- automatic inclusion of needed packages
- automatic exclusion of official packages
- fully configurable
- previews for unreal files with image extraction to ICO, BMP and JPG formats
- previews for image and text files
- can generate zip, tar.gz and tar archives
- can include zip comments and a special readme for gz (unix linefeeds)
- small executable size
- standalone construction - does not depend on registry or system DLL:s
- does not clobber your computer with temporary files


Installation:
=====================================================================================================
After unpacking the files, copy them somewhere in your hard disk. The UnrPack.exe and UnrPack.upp
should be located in the same directory. The UnrPack.upp contains the default configuration.
This readme file is not needed for operating the program. However, I suggest keeping it for
later reference.

As the UnrPack.exe does not depend on system files it will not need any special installation. You
can make a shortcut for it if you like. The startup directory may be anything - the UnrPack.exe
will find the UnrPack.upp automatically.


Starting the program:
=====================================================================================================
The program will start once you double click the UnrPack.exe icon. That's it.


First time configuration:
=====================================================================================================
All configuration information is contained on the "Project" tab which will be visible right after
you started the program. To get most out of UnrPack it is recommended to do the configuration
properly.

-----------------------------
PATHS
-----------------------------
The paths list is used by the UnrPack to determine where to look for needed (if any) packages.
You should add any directories that you are using to store the texture, sound, music etc. files.
If you have created a separate folder with standard Unreal folders, add the top folder after which
UnrPack will add the underlying standard folders automatically.

You can change the search order by the up/down buttons which move a selected row up/down. You can
also delete paths that you don't want to be searched. However, the standard Unreal installation
directories cannot be deleted as they will reappear automatically.

The checkbox on front of each pathname is used to determine if this path is to be used when searching
the packgages. When checked the path will be used - when not, the path will be skipped. The check
state of standard directories can be altered and this is the preferred way of eliminating them if
this need ever arises.

-----------------------------
DENY LIST
-----------------------------
The deny list is used to exclude files from your delivery. Any file whose name (without suffix)
appears in this list will be excluded. You can disable exclusions by uncheking them or you can also
remove some of them entirely.

The set that is in the original UnrPack.upp has the following installation files:
UnrealTournament release installation + 436 patch
UT2003 release installation + 2225 patch
All official bonus packs for both UT and UT2003


-----------------------------
FILE TYPES
-----------------------------
File types are used to determine how a file can be previewed and whether it may need additional
packages from the Unreal directories. The set which comes with the installation should be usable
in most cases so you shouldn't need to touch these.


To make the changes your default settings which will be in effect after UnrPack startup, save the
settings to the UnrPack.upp file. This file will be used to store default settings.


-----------------------------
README
-----------------------------
UnrPack is able to create the readme file automatically for you in case you feel lazy. It will not be
a poetical masterpiece but there will be some facts and it can be set up so that mapping sites can use
it for recognition.

The generator will read the template, fill in your persomal info and some facts it can sniff from the
map file.

Feel free to edit the template but be aware not to loose it completely as I'm not going to put the
tag descriptions here - they are in the original config file :)


Choosing files to your delivery:
=====================================================================================================
To add files to your delivery, select the "Files" tab and click the open button which will pop up
a file selection dialog. After choosing a file you may click the "Add" button and the selected
files will be appear in the file list. Note that you can only add files that are properly detected
and if you find out a reluctant file, this usually means some detection problem or then the file
appears in the deny list.
After each click on the "Add" button, the UnrPack will scan through the files for additional packages.
After you have done adding click the "Close" button which will close the addition dialog.


Previewing the files:
=====================================================================================================
To preview a file you must first select it. After it has been selected, the previews are accessible.
All Unreal image (texture and screenshot) previewers have the ability to export the image in ICO,
BMP or JPG format.


Creating the archive:
=====================================================================================================
The archiver itself is VERY simple. You have very little to choose from. Most important thing being
the way the archiver saves directory information. The recommended way is to use Unreal compatible
pathnames. After you click the Save button, UnrPack will let you choose the archive file name and
that's pretty much of it.


Saving your project for later duplication:
=====================================================================================================
UnrPack can save all your selection so that you can create an exact duplicate of the archive later
by loading the settings back in.



Have fun !


Esko 'Varpu' Ilola
