14.0:     JACKEDIT.EXE Information:    Sept. 09, 2009 rewrite
===================================================

IGM Utility:  The Gem Trader Player Database Editor (JACKEDIT)

Compile Date:  December 26, 2010.  v1.26 beta

Docs Updated:  December 26, 2010.

Status: January 2011 development

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

Dedication info:  JACKEDIT is dedicated to the memory of the
actor Christopher Reeve, who truly lived up to the title of
Superman.  He inspired millions of people to believe in heroes,
both on the movie screen and in real-life.
===========================================================


Section 1:  JACKEDIT USAGE NOTES:
------------------------------------------------------------
  The igm uses a JACKPLAY.DAT player database file.

  Everyone is to use the files inside JACKEDIT.ZIP until I
  am ready to re-release The Gem Trader IGM again, later
  this year in 2009.

  There is no change at this time to the IGM's Player Database
  structure.  I have not decided yet whether any are needed.
  So for now, either JACKEDIT v1.20 or its v1.21+ betas may
  be used with the IGM.
  ==========================================================

  ** Obtain copy of the JACKEDIT.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.

     The most up-to-date files will always be on the Castle
     Camelot site at http://camelot.legendarydragons.com/.

     See JACKEDIT.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.
     -----------------------------------------------------

     All JACKEDIT files are also inside GEMTWORK.ZIP, so if
     you get that archive, you don't really need JACKEDIT.ZIP.

  2) Unzip all files from JACKEDIT.ZIP into your IGM directory,
     using overwrite mode.
        E.g.:  pkunzip -n JACKEDIT.ZIP    (or GEMTWORK.zip)

  3) Change into the GEM TRADER IGM directory.  Verify you have
     a current JACKPLAY.DAT file.  If you don't, then you can't
     use JACKEDIT.EXE.

     The player database only tracks ONE day of IGM use.

     JACKEDIT can NOT be used without a JACKPLAY.DAT file.

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

     Notice: JACKBACK.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.

  5) The first time you run the utility, it will ask you for
     the path to the GEM TRADER IGM directory.  Type it in, and
     press ENTER to exit the dialog box prompt.  JACKEDIT.CFG
     file will be created in that directory.

  5) Run JACKEDIT.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 JACKPLAY.DAT file.  If one is not found, program will
     give error message and quit working.

     JACKEDIT 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.

  6) When you exit JACKEDIT, it will resave the JACKPLAY.DAT
     file so that any changes you made will be accessible to
     the IGM.  Note that JACKEDIT will never access, or make
     changes to the Player Database Backup file JACKBACK.DAT.

  ------------------------------------------------------------
  7) Deleting Database Records.       {Added 01/17/2010}

  Chris Gosse has reported that he has a player who is using
  Werewolf II to become immune from attack in LORD or other
  IGMs, possibly by disconnecting from the BBS while the
  player is inside an IGM.

  I have added a Delete Player Record option to JACKEDIT so
  that sysops who have a valid reason to delete a player's
  record can do so.  To prevent the feature from being used
  accidentally, it will ONLY work if JACKEDIT is being executed
  in Debug Mode.

  This IGM only writes records to the JACKPLAY.DAT file for
  players who actually have used the IGM during the current
  game day - or on the day that the IGM was used last.
  --------------------------------------------------------

  JACKEDIT 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 Used_Stuff IGM Maintenance
  process (for the first time that day).

  No records are retained from the previous day in this IGM
  since it does not have a Sleep in IGM feature, or a Bank
  feature.  When Used_Stuff is run for the first time, the igm
  automatically deletes the old JACKPLAY.DAT file.  Then it
  creates a new file that contains a record for the player who
  has entered the IGM.

  Once a record has been marked as "DELETED" in JACKEDIT, the
  user can always restore the old values by typing them back
  in.  There is no "UNDO" system.  Only three fields need to
  be changed if you wish to reverse the Deletion:  Real Name,
  LORD Name, and LORD Player Number.

  Records marked as "* DELETED *" will simply be ignored by the
  IGM while it is in use.

  You should jot down info on a record on paper before you
  try to delete any record, in case you need to restore it
  later to its original settings.

  The user/sysop *MUST* VERIFY that they wish to Delete the
  current player's record before JACKEDIT will finish the
  Delete Record process.  Users MUST use either the NO option or
  CANCEL option if they wish to cancel the deletion process.
--------------------------------------------------------------

8) Special Note.  If JACKEDIT is run in Debug Mode, the editor
   now shows [Debug Mode] on the screen's "Input key to change,
   or Q to Quit and Save." command line.   {Added 01/17/2010}
--------------------------------------------------------------

  Created JACKEDIT.TXT file on July 19th, 2005.

     End of Notes for JACKEDIT usage.
==============================================================


Section 2:  JACKEDIT VERSIONS HISTORY:
------------------------------------------------------------

  JACKEDIT v1.00 official release was done on:  Feb. 26, 2006:
  --------------------------------------------------------------
  http://camelot.legendarydragons.com/LordApps/jacked10.zip
  http://www.filegate.net/camelot/lordfile/jacked10.zip
  ==============================================================

  JACKEDIT v1.10 official release was done on:  Dec. 28th, 2006:
  --------------------------------------------------------------
  http://camelot.legendarydragons.com/LordApps/jacked11.zip
  http://www.filegate.net/camelot/lordfile/jacked11.zip
  ==============================================================

  The Gem Trader v2.50:  Distribution done on Dec. 30, 2006:
  http://camelot.legendarydragons.com/LordApps/gemtr250.zip
  http://www.filegate.net/camelot/lordfile/gemtr250.zip
  ==============================================================

  JACKEDIT v1.20 official release was done on:  Dec. 18th, 2007:
  --------------------------------------------------------------
  http://camelot.legendarydragons.com/LordApps/jacked12.zip
  http://www.filegate.net/camelot/lordfile/jacked12.zip
  ==============================================================

  The Gem Trader v2.60:  IGM programs released on Dec. 18th, 2007:
  http://camelot.legendarydragons.com/LordApps/gemtr260.zip
  http://www.filegate.net/camelot/lordfile/gemtr260.zip

  v2.60 programs distribution done online on Dec. 19th, 2007.
  ==============================================================


Section 3:  JACKEDIT DEVELOPMENT NOTES:
------------------------------------------------------------
    -- Initial development started on Jul. 19, 2005.
    -- Primary development was ended on Feb. 26, 2006.  (v1.00)

    -- Started 2nd development cycle on Dec. 04, 2006.
    -- Secondary development was ended on Dec. 28th, 2006. (v1.10)

    -- Started 3rd development cycle on Nov. 20, 2007.
    -- Ended 4th development cycle on Dec. 18th, 2007.  (v1.20)

    -- Started 4th development cycle on Sept. 08, 2009.  (v1.22)

    -- For usage only with the DOS LORD IGM.
    -- Requires you to have a current JACKPLAY.DAT file.

  Distributed inside the GEMTWORK.ZIP and JACKEDIT.ZIP beta
  archives when the IGM is in beta development.
=================================================================


Section 4:  The Gem Trader IGM Files Distribution:
------------------------------------------------------------

Official release program archives are posted here:

    http://camelot.legendarydragons.com/lordapps.htm
====================================================

The betas, not always up-to-date online, are located here:

1) The Castle Camelot web-site:  Hosted by Gary Hartzell.
   http://camelot.legendarydragons.com/IGM-Beta/jackedit.zip
      Primary distribution point.

2) The Nightfallgames.com web-site:  Hosted by Michael Everett.
   http://www.nightfallgames.com/files/Igms/jackedit.zip

3) The BBS Archives web-site.
   http://archives.thebbs.org/ra98a.htm
   -- Door Games: LORD IGMs  (web-page uses frames)

   http://archives.thebbs.org/ra99a.htm
   -- Door Games: LORD Utils</A> --  (web-page uses frames)

4) The LegendaryDragons.com FTP server.  Not always up-to-date
   ftp://legendarydragons.com/lord/
===================================================================


Section 5:  Gem Trader Files Hyperlinks:
------------------------------------------------------------

  JACKEDIT v1.00 download links:
  ** Officially released on February 27th, 2006.
  -----------------------------------------------------
  (1)  http://camelot.legendarydragons.com/LordApps/jacked10.zip
       - Castle Camelot Lordapps sub-directory.

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

  (3)  BBS Archives server, hosted by Mike Ehlert.
  ===================================================================


  JACKEDIT v1.10 download links:
  ** Officially released on Dec. 28th, 2006.
  -----------------------------------------------------
  (1)  http://camelot.legendarydragons.com/LordApps/jacked11.zip
       - Castle Camelot Lordapps sub-directory.

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

  (3) BBS Archives server, hosted by Mike Ehlert.
      See Lord_Igms directory for GEMTR250.ZIP, and
      see Lord_Utils directory for JACKED11.ZIP archives.
  ===================================================================


  JACKEDIT v1.20 download links:
  ** Officially released on Dec. 18th, 2007.
  -----------------------------------------------------
  (1)  http://camelot.legendarydragons.com/LordApps/jacked12.zip
       - Castle Camelot Lordapps sub-directory.

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

  (3) BBS Archives server, hosted by Mike Ehlert.
      See Lord_Igms directory for GEMTR260.ZIP, and
      see Lord_Utils directory for JACKED12.ZIP archives.
  ===================================================================

JACKEDIT Files:  Copyright 2005-2010 by Donald Tidmore.
=============================================================


Section 6:  Source Code Distribution Notes:  {12/19/07}
------------------------------------------------------------

If you wish to see all of the Pascal source code files used
by the The Gem Trader programs, you may download the igm's
source code archive from the Castle Camelot web-site.

http://camelot.legendarydragons.com/IGM-Code/gemtcode.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
JACKEDIT.  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 7: The Gem Trader Files Copyright Information:
----------------------------------------------------
GEMTRADE.EXE:  Copyright 2002-2010 by Donald Tidmore.

GEMTRADE.LDY and GEMFAIRY.LDY:  The LADY Scripts that this
     IGM is based upon are Copyright 2002-2010 by Donald Tidmore.

JACKEDIT.EXE:  Copyright 2005-2010 by Donald Tidmore.
==============================

JACKEDIT v1.00 -- Official release was done on 02/26/2006.
JACKEDIT v1.10 -- Official release was done on Dec. 28th, 2006.
JACKEDIT v1.20 -- Official release was done on Dec. 18th, 2007.

End of JACKEDIT.EXE documentation.
----------------------------------------

This file, along with the rest of The Gem Trader IGM files,
is Copyright 2002-2010 by Donald Tidmore.

All JACKEDIT.* files are Copyright 2005-2010 by Donald Tidmore.
=============================================================

The JACKEDIT.TXT was completely rewritten on Dec. 07, 2006.
Spell-checked file on Dec. 19, 2007 at 04:50 pm.

Jackedit.txt was rewritten for v1.20 on Dec. 18th, 2007.

Revised on December 26, 2010 at 06:30 pm.

