
                                 MAKEHOG.EXE
                        Farmer Joe's Descent HOG Maker

                    Copyright (c) 1995 by Moderne Software
                             All rights reserved.


Introduction
------------
MakeHOG is a utility program that can be used to combine multiple
user-generated Descent levels into a single HOG file.  This HOG file,
when used in conjunction with a Mission file (.MSN file), will be
recognized by Descent and will show up in its StartGame menu.

This MSN/HOG file combination is the method recommended by Parallax
Software when distributing new Descent levels.


Usage
-----
MakeHOG accepts any number of filenames which it will then combine into
a single HOG file.  Filenames may be specified in either a response
file, a mission file or individually on the command line.

The MakeHOG command line is:

    MAKEHOG [@ResponseFile | MissionFile | FileName ] ...

where:

  @ResponseFile is a text file which contains a list of files.  Note
that the name of a response file is preceeded by an '@' symbol on the
command line to differentiate it from other types of files.  For
example:

    MAKEHOG @response.txt

Each line in the response file should contain only a single filename.
Blank lines and comment lines starting with a semi-colon (;) are allowed
in the response file.

If a mission file is specified in the response file, MakeHOG will scan
though the mission file appropriately.

  MissionFile is a Descent text Mission file with an .MSN extension.
The contents of Mission files are described by Parallax Software in
documents released by them and will not be repeated here.  MakeHOG looks
for and interprets the "num_levels" and, if specified, the "num_secrets"
keywords in mission files.  The files associated with those keywords are
added to the generated HOG file.

  FileName is any DOS 6.x file specification.

Any number of response, mission and "normal" files may be specified in
any order on the MakeHOG command line.

In deciding on the name of the HOG file, MakeHOG first looks for a
mission file specified on the command line or in a response file.
Arguments are scanned in order of their specification on the command
line.  The name of the first mission file found will be used as the HOG
filename.  If no mission file is specified then the name of the very
first argument is used.  For example:

    MAKEHOG joeblow1.rdl farmrjoe.msn   <--- Creates FARMRJOE.HOG
    MAKEHOG joeblow1.rdl joeblow2.rdl   <--- Creates JOEBLOW1.HOG

MakeHOG always overwrites any existing HOG file with the same name as
the one it's creating.


Error Messages
--------------
If MakeHOG encounters a problem during execution, it will display one of
the following error messages.

Error: Could not open mission file XXX

  The specified mission file could not be found.

Error: Could not open response file XXX
Error: Could not read response file XXX

  The specified response file was not found or could not be read.

Error: Could not open input file XXX
Error: Could not read input file

  MakeHOG could not find, open or read file "XXX" specified on the
command line or in a mission or response file.  File probably does not
exist.

Error: Could not open HOG file XXX
Error: Could not write HOG header
Error: Could not write to HOG file

  MakeHOG could not create or write to the HOG file.  Most likely cause
of this problem is a full hard disk or subdirectory.

Error: Filename XXX is too long (Max: 13 chars)

  The maximum length of a filename stored in a HOG file is 13
characters, including the null string terminator.  This is no problem in
DOS 6.x with its 8.3 filenames, however, with the advent of Win95 and
long filenames, this will limit the length of your filenames.

Error: No num_levels setting in mission file XXX

  MakeHOG did not find a "num_levels" setting in the mission file.  All
mission files must have a "num_levels" setting.  The "num_secrets"
setting is optional.

Error: Invalid num_levels setting in mission file XXX
Error: Invalid num_secrets setting in mission file XXX

  The syntax of the "num_levels" or "num_secrets" line in a mission file
was incorrect.  Each line should have the keyword followed by an equal
sign ('=') followed by the number of level or secret-level files.  For
example:

num_levels=8
.
.
.
num_secrets=4

  The complete syntax of mission files (.MSN files) is described in
documents released by Parallax Software.

Error: Missing levels in mission file XXX
Error: Missing secret levels in mission file XXX

  The number of level or secret-level files specified in the mission
file do not correspond with the number specified on the "num_levels" or
"num_secrets" line.  For example, if num_levels=8, there must be at
least 8 files listed in the mission file immediately following that
line.

Error: Not enough memory

  Your system does not have enough memory to run MakeHOG.  MakeHOG uses
about 100K of memory.  If you don't have this much memory, you probably
don't have Descent either.

Internal program error: Unknown display message

  The MakeHOG message display system was passed an unrecognized message
ID.  This message should never be displayed.


Program Use and Distribution
----------------------------
MakeHOG is copyrighted material owned by Moderne Software.  Free use of
MakeHOG is granted for the creation of Descent levels that are to be
distributed at no charge.

MakeHOG may not be used for the creation of Descent levels for which a
fee will be charged unless prior permission is granted by Moderne
Software.  Contact Moderne Software at the electronic addresses listed
at the end of this document if you wish to use MakeHOG to generate
commercial Descent levels.

MakeHOG may be distributed via computer bulletin boards and other common
transfer media provided no fee is charged.  For distribution via all
commercial, non-free methods, prior permission from Moderne Software is
required.


The No-Warranty Warranty
------------------------
MakeHOG has been tested and no known problems exist.  Should you
experience a problem with MakeHOG, I would appreciate hearing from you.
However, there is no guarantee that I will fix the problem, nor that I
will even contact you.


Non-Support Technical Support
-----------------------------
MakeHOG is distributed as-is.  If you have a problem, please let me
know.  Maybe I'll be able to help.  Maybe you'll never hear from me.  In
other words, I'm just like any other software company.


Should You Wish To Say Nice Things About Me
-------------------------------------------
Moderne Software can be reached at the following electronic addresses:

Internet   : calwas@ix.netcom.com
CompuServe : 73507,2272

