PUD Browser Readme File
Version 1.1
May 26, 1997

--------
Overview
--------

PUD Browser is a Warcraft II PUD file viewer which, unlike the editors, 
supports the viewing of Warcraft maps at full screen size.  The program 
allows the user to quickly browse a collection of PUD's, directly 
generate GIF files of the maps, and print them on both color and black &
white printers.  PUD Browser was written to be used as a tactical guide
for multi-player game play and and allow the quick evaluation of PUDs.
In this regard, the graphics has been designed for easy identification
of terrain features and for fast rendering on the screen.

------------
Installation
------------

PUDBrowser is a 32 bit windows program written for Windows 95.  We have
not attempted to run it in Windows 3.1/3.11 and don't know if it will
work in that environment.  In order to have a chance to work in 3.11,
you will need to install the latest version of Win32s and WinG (both
are available at Blizzard's web page http://www.blizzard.com or from
Microsoft).  If anyone tries this, please let us know the results.

To install PUD Browser, copy the file PudBrowse.exe (note this is a
name change from previous versions) to your Warcraft II PUD's folder.
The program can be executed from any directory, but it is more
convenient to have it with the PUD files.

To run PUD Browser, click on PudBrowse.exe from Windows 95 Explorer or
add a shortcut to your program menu or desktop.  Another option is to
set PUD Browser as the default program to run for .pud files so that
when you double click on a PUD file, PB opens automatically.

---------------------
Program Functionality
---------------------

Opening files
-------------

The program should be very intuitive for anyone familiar with the
Windows 95 user interface.  Individual PUD files are opened using the
normal File/Open menu selection or Open button on the tool bar.  Once a
file is opened, the window can be resized in the normal way and the
relative sizes of the two window panes can be adjusted by moving the
splitter bar.

Browsing files 
--------------

Sequential Browse allows a collection of files in the same folder
(directory) to be selected at once and browsed using the Navigation menu
or equivalent arrow buttons on the tool bar.  This feature is activated
by the File/Browse menu item or Browse tool bar button.  This opens a
file selection dialog box, similar to the file open dialog, which allows
multiple files to be selected.  Multiple file selection is as follows:

 - To select a contiguous set of files, select the first file with the
   left mouse button and the last file with the left mouse button with
   the shift key held down.

 - To select a random set of files from the directory, select the first
   file with the left mouse button, and select all subsequent files with
   the left mouse button with the control key held down.

Typing file names in the edit box of this dialog is supported but each
file name must be entered within double quotes (e.g., "gardwar.pud").
Wildcards are not currently supported.

While in browse mode, the current state of the browse progress (e.g.,
'Browsing 5 of 20') is displayed in the right side of the status bar
on the bottom of the window.

Resource indicator
------------------

The amount of gold in a mine or oil in a patch can be determined by
moving the mouse cursor over the mine or patch in the map view.  When a
mine or patch is selected, the cursor changes from an arrow to a cross
and the amount of the resource appears in the left side of the status
bar at the bottom of the window.

Unit display option
-------------------

The Options menu allows the user to select whether to show only the
player starting positions or to show the positions of all player units.
If starting positions are shown, people players are depicted by a circle
and computer players are depicted by a square.  This option can be
either selected via the Options menu or the unit selection tool bar
buttons.

Print and print preview
-----------------------

PUD Browser currently supports printing one PUD/page on both color and
black & white printers and in either landscape and portrait mode.  The
Print Setup, Print Preview, and Print functionality work as for any
other Windows 95 application.  This functionality has been throughly
tested on HP Laser Jet 4L (b&w) and HP 560C (color) printers.  Any
problems with other printers should be reported to the address below,
with a sample printout if possible.

It should be noted that the print quality of graphical bitmap images
(which PUD Browser uses to print the maps) is very dependent on the
settings selected in the Printer Properties dialog box.  If the printed
map quality is unsatisfactory, experiment by changing those settings
such as print density, etc.

GIF file generation
-------------------

PUD Browser can produce 256 color GIF files directly from PUD files.
When the File/GIF menu item or tool bar button is selected, file save
dialog box opens which allows the specification of both the save file
name and GIF image resolution (i.e., size) in pixels.  There are
standard sizes available plus the option to produce the GIF image at
the same size as the map currently displayed in the window.  To pick a
custom image size, resize the map image with the splitter bar as
desired.  The current size of the map is displayed in the status bar at
the bottom of the window.

There are a couple restrictions with this version of the GIF generation.
The GIF algorithms will be completely rewritten and these will be fixed
in the future, but they weren't deemed serious enough to delay the
current release. The restrictions are:

 - When creating GIF files, the display screen must be set to 256
   colors.  If you normally run at higher color depths, you must reset
   the screen settings via the Windows 95 Display Property Sheet and
   reboot.  If you forget to reset and try to create GIF's, PB will
   issue a warning message.  All other PB functions work at all color
   levels.

 - Occasionally a created GIF file will be corrupt showing a partial
   image at the top with garbage at the bottom.  This is due to some
   unique data combination in the compression algorithm.  When this
   happens either output the GIF at a slightly different size or use the
   Warcraft Editor to make a minor modification to the map at a position
   above where the problem starts.  Adding a tree or making the ground
   dark won't change the way the GIF looks but changes the data enough
   to eliminate the bad character sequence.  Sometimes you may need to
   try this a couple of times to get it to work.  Be sure when you save
   the modified version you give it another name so you don't corrupt
   the original PUD file.

PUD Info file generation
------------------------

PUD Browser can write the text information about the PUD, which is
displayed in the right pane of the window, to a PUD Info file (*.pfo).
This is initiated by both an item in the File menu an associated tool
bar button.

PUD reload
----------

The File/Reload menu item and associated tool bar button are primarily
for when using PUD Browser and the Warcraft Editor simultaneously.  In
this mode, you would open the same file in both PUD Browser and the
editor.  After making some editing changes, hit the save file button in
the editor and go to PUD Browser and hit the reload button.  Your
changes will then be reflected in the PUD Browser display.

-------------------------
Known Errors/Restrictions
-------------------------

The only known errors and restrictions with the current version of PUD
Browser are GIF file restrictions discussed above.

-----------------
Technical Support
-----------------

If you have any problems or questions regarding PUD Browser, please
contact billw@one.net and we will try to help you or fix the problem.
Any feedback, both positive and negative, will be appreciated.

----------------
Revision History
----------------

Version 1.1 (May 26, 1997)
 - Added size of starting mines and expansion mines to text window and
   PUD Information File
 - Added resource information to map print outs
 - Fixed starting position graphics for small resolutions to be small 
   square instead of horizontal line

Version 1.0 (April 26, 1997)
 - Added the direct generation of GIF files from PUD's (see restrictions
   noted above)
 - Added the generation of a PUD Information File
 - Added additional statistical information about the PUD to the text
   pane
 - Added a reload button to reload the currently opened file
 - Added map size, in pixels, to the status bar
 - Added browse progress indicator to the status bar
 - Improved print quality for black & white printers
 - Fixed problem with checkerboard effect in 16 and 24 bit color modes
 - Fixed problem where the print menu item and button appeared to be
   inoperative and nothing happened when selected

Version 0.2 Beta (January 5, 1997)
 - Implemented color and B&W printing - one PUD/page
 - Added toolbar buttons to select 'start positions' or 'all units'
 - Changed cursor to cross when over gold mine or oil well and value is
   displayed in status line

Version 0.1 Beta (November 21, 1996)
 - Original release

----------
Disclaimer
----------

The authors of PUD Browser, hereby disclaim all warranties relating to
this software, whether express or implied, including without limitation
any implied warranties of merchantability or fitness for a particular
purpose.  The authors will not be liable for any special, incidental,
consequential, indirect or similar damages due to loss of data or any
other reason, even if the authors have been advised of the possibility
of such damages.  In no event shall the author's liability for any
damages ever exceed the price paid for the license to use the software,
regardless of the form of the claim.  Any person using the software
bears all risk as to the quality and performance of the software and by
use of  the software, accepts all of the above conditions.

Official Home of PUD Browser
   http://w3.one.net/~billw/PudBrowser/

Authors:
   Bill Wright (billw@one.net)
   Jim Weirich (jweirich@one.net)

Problem Reporting:
   Bill Wright
   3643 Sherbrooke Drive
   Cincinnati, OH 45241
   (513) 733-1499
