The LORD Cavern - LC2EDIT.TXT

Player Database Editor Utility program docs

LC2EDIT v1.00 was officially released on Dec. 28th, 2007.

LC2EDIT.EXE Status:  v1.17 beta.  ** January 2011 Beta

Compile Date:  December 26, 2010.

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

** Uses Player Database structure revised on Nov. 30, 2009
   to incorporate a Fairies Received per Day Limit variable.

12/05/09: Enabled use of Max Fairies/Day Limit in LC2EDIT.
   Requires usage of LC2EDIT.EXE version 1.12 or later.
--------------------------------------------------------

For use when utility is in beta development:

    http://camelot.legendarydragons.com/IGM-Beta/lc2-edit.zip

Notes: Includes source code file for LC2EDIT utility.
       v1.00 utility was officially released on Dec. 28th, 2007.

LC2EDIT.EXE is updated to support a Player Database structure
change made 04/25/2009.  It will now only work with compilations
of LORDCAVE.EXE made on/after 04/25/2009.  It can NOT be used
with any CAVEPLAY.DAT files that are dated before that date.
============================================================


LC2EDIT Author:  Donald Tidmore.

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


LC2EDIT v1.01+ betas are *NOT* usable with any old version
or old compilation of LORD Cavern that is prior to v1.76.2.

Work started on development of new LORDCAVE.EXE and LCSETUP.EXE
program files on Dec. 28th, 2007, using new IGM Player Database
format and new IGM Config file format.

** Use *ONLY* LC2EDIT v1.12+ Betas with LORD Cavern's v1.76.2+
beta programs, as of Nov. 30th, 2009.

Previous versions of LC2EDIT dated BEFORE Nov 30, 2009 will
no longer work due to a change in the igm's player database
structure.  Donald. 11/30/2009 note.
=============================================================


Dedication:  LC2EDIT.EXE is dedicated to Gary Hartzell and
Jason Brown, as of Dec. 28th, 2007.
============================================================


Section 1:  LC2EDIT UPDATE NOTES:
------------------------------------------------------------

Caveat:  This program is *NOT* usable in any circumstances
with any version of LORD Cavern prior to v1.76.2.

** Requirements:  You *MUST* be using a CAVEPLAY.DAT player
database file.  And you MUST be using a LORDCAVE.EXE program
which is dated on/after Nov. 30th, 2009.  The same applies to
usage of LCSETUP.EXE.
---------------------------------------------------------------


Section 2:  LC2EDIT Program Usage Notes:
------------------------------------------------------------
  Note:  For access to revise the LORD Player Number field,
  use the command LC2EDIT /DEBUG to run the Player Database
  Editor utility.  ** READ the Warning about this function of
  LC2EDIT.EXE before using it!!  **

  Note 2: 01/20/10. Rewrote Delete Player Record option so
  it now only works if LC2EDIT is run in Debug Mode.
  ===========================================================

  ** Obtain copy of LC2-EDIT.ZIP from one of my distribution
     sites, or get it from me via email directly.

     The archive's primary distribution sources are my Castle
     Camelot and Camelot LordNews FDN web-sites;  and the
     Nightfallgames.com LORD Files Library site.

     Other distribution sources are the BBS Archives site's
     FTP server, and the FTP server at legendarydragons.com.

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

     See LC2-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) LC2EDIT Config:  Revised 06/24/2008

     During the LCSETUP Config process, if the user Installs the
     IGM or does a re-install, LCSETUP.EXE will now automatically
     create a LC2EDIT.CFG file for the user, using the location
     that LCSETUP.EXE is being executed from.

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

     If you're updating from one version of LC2EDIT to a newer
     one, they all use the same LC2EDIT.CFG file.  Its format
     will never change.  LC2EDIT does not use CAVE-USE.TXT, or
     the igm's CAVERN2.DAT and LC-EXTRA.CFG config files.

  2) LC2EDIT 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.

     (1) The Lord Player Number field is display-only.  That is
     because I don't see any valid reason to allow users to
     fiddle around with it.   * Enabled in late Dec. 2007.

     *** Do not, under ANY circumstance, alter the value of the
     REALNAME variable *UNLESS* you ABSOLUTELY know what you
     are doing.  That variable is the ONLY way currently that
     the igm has of specifically matching an existing Player
     Database record with a player during the IGM entry sequence.
     
    -----------------------------------------------------------
     NOTES:   LORDCAVE.EXE is the ONLY program that is normally
     allowed to alter a player record's Player Number.  You also
     should not EVER change the player's REAL NAME value either.

     --------------------------------------------------------
     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 either field while using the LC2EDIT.EXE utility.

     Do *NOT* mess with the LORD Player Number for any player,
     UNLESS YOU KNOW ABSOLUTELY that the listed value 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 the Player Number variable'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 LC2EDIT to do so *ONLY* if you
     are ABSOLUTELY sure that you know what you are doing!!!
     ---------------------------------------------------------

  3) When you exit LC2EDIT, it will resave the CAVEPLAY.DAT
     file so that any changes you made will be accessible to
     the IGM.  Note that LC2EDIT will never access, or make
     changes to the Player Database Backup file CAVEBACK.DAT.

  ------------------------------------------------------------
  4) Deleting Database Records.       {Added 01/20/2010}

  Chris Gosse has reported that he has a player who is using
  The Werewolf v3.0 to become immune from attack in LORD or
  other IGMs, possibly by disconnecting from the BBS while
  the player is inside an IGM.  (He has confirmed that the
  cheating player is using Jay Hodges' Werewolf IGM, not mine.)

  I have added a Delete Player Record option to LC2EDIT 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 LC2EDIT is being executed
  in Debug Mode.

  This IGM only writes records to the CAVEPLAY.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.
  --------------------------------------------------------

  LC2EDIT 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 CAVEPLAY.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 LC2EDIT, 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 LC2EDIT 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 LC2EDIT 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/20/2010}
-----------------------------------------------------------------

Note: Even if you just view records in LC2EDIT, without changing
    a single value, the editor utility will still resave the
    CAVEPLAY.DAT file when you exit.  The program has no way
    to know if the user changed values in the records or not.

           End of Notes for LC2EDIT usage.
=================================================================


Section 3:  LC2EDIT DEVELOPMENT NOTES:
------------------------------------------------------------
    -- Initial development started on Dec. 03rd, 2007.
    -- First development cycle was ended on Dec. 28th, 2007.

    -- Second development cycle started on Dec. 31th, 2007.

    -- Requires you to have a current CAVEPLAY.DAT file,
       that was made by LORD Cavern v1.76.2 Beta.

    Distributed inside the LC2EDIT.ZIP and CAVEWORK.ZIP archives.

    -- For usage only with the DOS LORD IGM.
=================================================================


Section 4:  The LORD Cavern IGM Files Distribution:
------------------------------------------------------------

Official release program archives are posted here:

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

  Beta download links:
  ---------------------
  http://camelot.legendarydragons.com/IGM-Beta/lc2-edit.zip
  -- Only contains the OUTSEDIT.* files.

  http://camelot.legendarydragons.com/IGM-Beta/cavework.zip
  -- Primary IGM distribution archive.
============================================================

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/lc2-edit.zip
      Primary distribution point.

2) The Nightfallgames.com web-site:  Hosted by Michael Everett.
   http://www.nightfallgames.com/files/Igms/lc2-edit.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:  Outlands Tavern Files Hyperlinks:
------------------------------------------------------------

Official download links for LC2EDIT.EXE v1.00:
-----------------------------------------------

On Castle Camelot web-site:
    http://camelot.legendarydragons.com/LordApps/lc2ed10.zip

On Camelot LordNews FDN web-site:
    http://www.filegate.net/camelot/lordfile/lc2ed10.zip

On NightfallGames LORD Files Library web-site:
    http://www.nightfallgames.com/files/Utils/lc2ed10.zip
-----------------------------------------------------

This section only covers the versions produced by me.
It does not cover the versions that were made by Jason Brown.

v1.5:  http://www.filegate.net/camelot/lordfile/cave15.zip
       -- Released on Nov. 02, 2002. 1st version done by me.

v1.6:  http://www.filegate.net/camelot/lordfile/cave16.zip
       -- v1.6 was officially released on Nov. 07, 2003.

v1.7:  http://www.filegate.net/camelot/lordfile/cave17.zip
       -- v1.7 was officially released on June 11th, 2005.
----------------------------------------

v1.8:  Development started on Dec. 31, 2007 of v1.71 Beta
       of the LORD Cavern IGM.  And of LC2Edit v1.02.
===========================================================


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

1) http://camelot.legendarydragons.com/IGM-Beta/lc2-edit.zip
   Primary distribution point: Castle Camelot web-site.

2) http://www.nightfallgames.com/files/Igms/lc2-edit.zip
   Nightfallgames.com LORD server site.

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)
===================================================================


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

You MUST have my permission to use anything from this IGM's
source code archive, or that of Jason Brown.  It is NOT
freely usable by anyone without our permission.

One exception.  The LC2EDIT.* program files are my own
creation, so I can grant you permission to use them as you
want to.  However, you are obligated to let me know what
you want to do with this IGM's source code files first.
-----------------------------------------------------------

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

http://camelot.legendarydragons.com/IGM-Code/cavecode.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.
--------------------------------------------------------------

Exception:  Dennis Collins is the only person other than Jason
Brown who is automatically granted permission to work on this
IGM's source code, since he is helping me with the development
of Outlands Tavern currently.  He is also helping me with work
on the RHP Toolkit programs.
---------------------------------------------------------------

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 and CHASATTR.PAS files.
-------------------------------------------------------------

You must have the explicit permission of Jason Brown, who
created The LORD Cavern, also titled as The L.O.R.D. Cavern,
before you can legally use any of the source code files used
by this IGM.

Notes: The modified DDIGM tool-kit source code unit files used
by this IGM are inside the CAVESRC2.ZIP archive, which is
inside CAVECODE.ZIP.  You are welcome to use them, as long
as you recognize that they belong to the tool-kit's creator.
-----------------------------------------------------------

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
LC2EDIT.  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: LORD Cavern Files Copyright Information:
----------------------------------------------------
LORDCAVE.EXE:  Copyright 1995-2002 by Jason Brown.
               Copyright 2002-2010 by Jason Brown and Donald Tidmore.

LCSETUP.EXE:  Copyright 2003-2010 by Donald Tidmore.
         This program is based on Jason Brown's SETUP.EXE
         utility that was used before version 1.5.

LC2EDIT.EXE:  Copyright 2007-2010 by Donald Tidmore.
=====================================================

** Program file created on Dec. 04th, 2007. **

LC2EDIT.TXT was created on Dec. 03rd, 2007.

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

