HAGEDIT.EXE Information:  (Created on 09/08/2008)
===================================================

IGM Utility:  The Nice Hag Player Database Editor (HAGEDIT)

This utility program was created by Donald Tidmore.
HAGEDIT is based upon the Chasware LPEdit utility.

Status:  ** Official release processing.   v1.00

Required:  Any compilation of NICEHAG.EXE made after
           Dec. 24th, 2008, which uses HAGPLAY.DAT file.

Compile Date:  December 31, 2010.

Docs Update:   December 31, 2010.
------------------------------------------------------------

Dedications:  As of 12/24/08, HAGEDIT is dedicated in honor
of my friend Shannon Talley.
===========================================================


Section 1:  HAGEDIT USAGE NOTES:
------------------------------------------------------------
  Note 1:  HAGEDIT.EXE is designed to work with all
  compilations of the The Nice Hag IGM which are dated
  on Dec. 25th, 2008 or later.  It is intended only for
  usage with v2.38.5+ betas, or with v2.40 of the IGM.

  Note 2:  For access to revise the LORD Player Number field,
  use the command HAGEDIT /DEBUG to run the Player Database
  Editor utility.  ** READ the Warning about this event's
  usage before using it!!  **
  ==========================================================

  Note: Ignore all references to HAGEDT10.ZIP for awhile.
  The program requires more work before it can be released,
  so everyone is to continue using HAG-EDIT.ZIP. 12/25/08 note.
  ----------------------------------------------------------

  ** Obtain copy of the HAGEDT10.ZIP archive. Primary
     distribution sources are my Castle Camelot and Camelot
     LordNews FDN web-sites.  Along with the BBS Archives
     web-site's FTP server, the Nightfallgames.com server,
     and the LegendaryDragons.com FTP server.  Files will
     also be available from the Fidotel BBS web-site.  The
     most up-to-date files will always be on the Castle
     Camelot site at http://camelot.legendarydragons.com/.

     See HAG-EDIT.ZIP for documentation files updates that I
     periodically post to the Castle Camelot web-site.

     While program is in beta development, contact me for
     the latest IGM archives via email.
     ======================================================

  1) Unzip all files from HAGEDT10.ZIP (or HAG240.ZIP) into
     your IGM directory, using overwrite mode.

        E.g.:  pkunzip -n HAG-WORK HAGEDIT.*
        Or     pkunzip -n HAGEDIT

  2) Change into The Nice Hag IGM directory.  Verify you have
     a current HAGPLAY.DAT file.  If you don't, then you can't
     use HAGEDIT.EXE.

     The player database only tracks ONE day of IGM use.

     HAGEDIT can NOT be used without a HAGPLAY.DAT file.

  3) Notes on Player Database Restoration File:  HAGEDIT is
     not meant for use with the HAGBACK.DAT file.  But the
     file, once renamed to HAGPLAY.DAT, can be used with it
     since the two files use the same player database structure.

     Notice: HAGBACK.DAT is INTENDED only for use by the
     IGM itself for one purpose only:  Restoring the Player
     Database file during IGM operations if it gets deleted
     by accident or on purpose while the IGM is in use.

  4) HAGEDIT Config:

     During the NICEHAG Install process, NICEHAG.EXE will
     create a HAGEDIT.CFG file for the user automatically, using
     the location that NICEHAG.EXE is being executed from.

     The first time HAGEDIT is executed, if HAGEDIT.CFG does
     not exist -- in the directory you are running it from --,
     the utility will ask you for the path to the The Nice Hag
     IGM directory.  Type it in, and press ENTER to exit the
     dialog box prompt.  The HAGEDIT.CFG file will be created
     in the directory that you specified.

  5) Run HAGEDIT.EXE.  If a config file is not in the directory
     you run it from, it will ask you to create one - as noted
     above.  If config file is found, it then checks for existence
     of HAGPLAY.DAT file.  If one is not found, program will
     give error message and quit working.

     HAGEDIT has only one screen of data.  It shows database
     fields in the order they are listed in the player database
     record structure (usually).  Each value, with one exception,
     may be set to any value that is valid for it.

     The Lord Player Number field is display-only.  That is because
     I don't see any valid reason to allow users to fiddle around
     the LORD Player Number field.

     NOTES:   NICEHAG.EXE is the ONLY program that is normally
     allowed to alter a player record's Player Number field, in
     regards to The Nice Hag IGM.

     --------------------------------------------------------
     Exception:  If the utility is run using the /DEBUG parameter,
     then the user is allowed to modify the value of the LORD
     Player Number.

     The user *MUST* use extreme caution in doing *ANY* changes
     to this field while using the HAGEDIT.EXE utility.

     Do *NOT* mess with the LORD Player Number variable's value
     UNLESS YOU KNOW ABSOLUTELY that it is invalid.  Use either
     DOS LORD's LORDCFG.EXE Player Database Editor or my Chasware
     LPEdit v1.40 utility to obtain the correct values *BEFORE*
     you try to change this IGM database stat's value.

     The IGM uses very specific program code in its IGM
     Maintenance process for correcting an invalid LORD Player
     Number stat's value.  Use HAGEDIT to do so *ONLY* if you
     are ABSOLUTELY sure that you know what you are doing!!!
     ---------------------------------------------------------

  6) When you exit HAGEDIT, it will resave the HAGPLAY.DAT
     file so that any changes you made will be accessible to
     the IGM.

  ========================================================
  7) Deleting Database Records.

  HAGEDIT uses the X menu key code for its Delete Player
  Record process.  Once a record has been deleted, it is
  not physically deleted from the player database file until
  the next day when the IGM runs its Save_Player_Data
  IGM Maintenance process.  At that time, any record that
  is marked as *DELETED* is kept OUT of the new Player
  Database File (HAGPLAY.DAT) that the IGM is creating.

  Once a record has been deleted in HAGEDIT, the user can
  always restore the old values by typing them back in.  There
  is no "UNDO" system.  Once the IGM itself removes a player
  database record, that record no longer exists.

  User *MUST* VERIFY that they wish to Delete the current
  player's record before HAGEDIT will finish the Delete
  Record process.  User MUST use either the NO option or
  CANCEL option if they wish to cancel the deletion process.

     End of Notes for HAGEDIT usage.
==============================================================


Section 2:  HAGEDIT VERSIONS HISTORY:
------------------------------------------------------------

  HagEdit v1.00 - not released yet.

For later use:
    URL: http://www.filegate.net/camelot/lordfile/hagedt10.zip
    Note: It is not usable with v2.38 Beta or older versions of the IGM.
==============================================================


Section 3:  HAGEDIT DEVELOPMENT NOTES:
------------------------------------------------------------
    -- Initial development started on Sept. 08, 2008.
  ------------------------------------------------------

    -- For usage only with the DOS LORD IGM.

    -- Requires you to have a current HAGPLAY.DAT file.
    -- You also need to be using v2.38.5+ betas or v2.40 of
       the NICEHAG.EXE IGM program.

    -- Requires you to have a current HAGPLAY.DAT file,
       if you wish to view/edit its primary player database
       records.

    -- As of 12/25/2008, the IGM's player database structure
       is modified to track a GOLD stat;  which replaces the
       unused FOREST stat.
    ----------------------------------------------------------

  Distributed inside the HAG-EDIT.ZIP beta archive, when
  HAGEDIT is in Beta Development. Official release distribution
  is done using the HAGEDT10.ZIP and HAG240.ZIP archives.

  Distribution is also done inside HAG-WORK.ZIP.
=================================================================


Section 4:  The Nice Hag IGM Files Distribution:
------------------------------------------------------------
HAGEDIT v1.00 -- In official release processing as of 09/12/09.

THE NICE HAG v2.40 -- In official release processing as of 09/12/09.
------------------------------------------------------------

  HAGEDIT v1.00 download links:   (NOT USABLE YET)
  -----------------------------------------------------
  (1)  http://camelot.legendarydragons.com/LordApps/hagedt10.zip
       - Castle Camelot Lordapps sub-directory.

  (2)  http://www.filegate.net/camelot/lordfile/hagedt10.zip
       - Camelot LordNews FDN's lordfile sub-directory.

  (3)  http://www.nightfallgames/com/files/Utils/hagedt10.zip
       - NightfallGames LORD Files Library - LORD Utilities directory.

  Also available from Mike Ehlert's BBS Archives server.
  ===================================================================


Source code distribution notes:  08/13/07
---------------------------------------------------------------
If you wish to see all of the Pascal source code files used
by The Nice Hag programs, you may download the igm's source
code archive from the Castle Camelot web-site.

http://camelot.legendarydragons.com/IGM-Code/hag-code.zip

You are granted viewing rights only to these Pascal source
code files.  No one is allowed to use the source code files
on their own without my explicit permission, with the exception
of their usage to make similar LORD programs of your very own.
---------------------------------------------------------------

Usage of Charlie Wardick's Chasware Library is freely granted
to anyone who wishes to use it.  However, remember it is his
copyrighted property, and you do NOT have rights without his
permission to alter its CHASWARE.PAS, CHASWIGM.PAS, and
CHASATTR.PAS files.
-------------------------------------------------------------

Note: The TechnoJock's Gold Toolkit, which is no longer
supported or available for purchase online, is used to make
HAGEDIT.  If you wish to use my set of TPU files for it, let
me know.  Just be aware that its authors are not available for
technical support or product purchase/registration.
===============================================================


Section 5: The Nice Hag Files Copyright Information:
----------------------------------------------------
This file, along with the rest of The Nice Hag IGM's files,
is Copyright 2002-2011 by Donald Tidmore.

Created HAGEDIT.TXT documentation file on Sept. 08th, 2008.
The HAGEDIT.txt was completely rewritten on Dec. 24th, 2008.
                         
NICEHAG.EXE:  Copyright 2002-2011 by Donald Tidmore.

HAGEDIT.EXE:  Copyright 2008-2011 by Donald Tidmore.

End of HAGEDIT.EXE documentation.

All HAGEDIT.* files are Copyright 2008-2011 by Donald Tidmore.
=============================================================

Revised on:   December 31, 2010 at 06:00 pm.

