Violet's Cottage II Player Database Editor Documentation:
** Total rewrite started on 06/03/08 using ROL2EDIT.TXT info.
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

IGM Utility:  Violet's Cottage II Player Database Editor (VIO2EDIT)
VIO2EDIT Author:  Donald Tidmore.

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

Current Status: v1.10 Non-Beta.  ** January 2011 Non-Beta.

Compile Date:  December 27, 2010.

Docs Update:   December 27, 2010.

Player Database structure revised on:  Aug. 10th, 2008.
------------------------------------------------------------


Section 1:  VIO2EDIT UPDATE NOTES:
------------------------------------------------------------

Dedication Info:
    This IGM is dedicated to Violet's Cottage's author Trevor
    Herndon, and to an old BBS friend, Lloyd Hannesson.

    The VIO2EDIT player database editor is dedicated to the
    memory of Roy Rogers, as of 09-28-2005.

VC II is the abbreviation for Violet's Cottage II.
-------------------------------------------------------

07/27/08: Updated the Player Database structure used by
Violet's Cottage II.  The IGM no longer uses a NPC named
Violet's Father, which has been replaced by Violet's Uncle.
Too many people thought that when they defeated the NPC
they were defeating/killing LORD's Master Turgon.
=========================================================

The IGM now uses a VIO2BACK.DAT player database backup file,
but VIO2EDIT does not use it.

** Requirement:  This program requires a VIO2PLAY.DAT file,
and will not work without one. It must be located in the
directory that you specify when you create the VIO2EDIT.CFG
utility program config file.
---------------------------------------------------------------


Section 2:  VIO2EDIT Program Usage Notes:
------------------------------------------------------------
  Note:  For access to revise the LORD Player Number field,
  use the command VIO2EDIT /DEBUG to run the Player Database
  Editor utility.  Read the warning about making changes to
  the PlayNum variable before using it.  Implemented in VIO2EDIT
  on Jun. 03rd, 2008.

  Note 2: 01/18/10. Added Delete Player Record option which will
  only work when VIO2EDIT is run in Debug Mode.
  ===========================================================

  ** Obtain copy of the VIO2EDIT.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 VIO2EDIT.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) VIO2EDIT Config:  Revised 06/24/2008

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

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

     If you're updating from one version of VIO2EDIT to a newer
     one, they all use the same VIO2EDIT.CFG file.  Its format
     will never change.  VIO2EDIT does not use VC2USAGE.TXT, or
     VIOLET2.DAT.  It also does not directly use VIO2BACK.DAT.

  2) VIO2EDIT 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 with it.

     NOTES:   VIOLET2.EXE is the ONLY program that is normally
     allowed to alter a player record's Player Number field, in
     regards to the Violet's Cottage II 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 the PlayNum field while using the VIO2EDIT.EXE utility.

     Do *NOT* mess with its value UNLESS YOU KNOW ABSOLUTELY that
     the value is invalid.  Use either DOS LORD's LORDCFG.EXE
     Player Database Editor or my Chasware LPEdit v1.40 utility
     to obtain the correct value for *ALL* of your players
     *BEFORE* you try to change the LORD Player Number stat.

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

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

  ------------------------------------------------------------
  4) Deleting Database Records.       {Added 01/18/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 VIO2EDIT 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 VIO2EDIt is being executed
  in Debug Mode.

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

  VIO2EDIT 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 VIO2PLAY.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 VIO2EDIT, the
  user can always restore the old values by typing them back
  in.  There is no "UNDO" system.  Only three fields need to
  be VIO2ged 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 VIO2EDIT 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 VIO2EDIT is run in Debug Mode, the editor
   now shows [Debug Mode] on the screen's "Input key to VIO2ge,
   or Q to Quit and Save." command line.   {Added 01/18/2010}
-----------------------------------------------------------------

Note: Even if you just view records in VIO2EDIT, without changing
    a single value, the editor utility will still resave the
    VIO2PLAY.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 VIO2EDIT usage.
=================================================================


Section 3:  VIO2EDIT DEVELOPMENT NOTES:
------------------------------------------------------------
    -- Initial development started on Aug. 04, 2005.  (v1.00)
    -- First stage development ended on Oct. 12th, 2005.

    -- Second development cycle started Jun. 03rd, 2008.

    -- Usable with current betas of VIOLET2.EXE, and with
       version 1.20.

    -- For usage only with the DOS LORD IGM.

    -- Requires you to have a current VIO2PLAY.DAT file.

    ** VIO2EDIT will no longer work with any version of
       Violet's Cottage II created before Jul. 27th, 2008.

  Distributed inside the VC2-WORK.ZIP beta archive.  Whenever
  VIO2EDIT.EXE is in development, it is also distributed using
  the VIO2EDIT.ZIP beta archive.
------------------------------------------------------------


Section 3-B:  VIO2EDIT VERSIONS HISTORY:
------------------------------------------------------------
    VIO2EDIT v1.00: Officially released on Oct. 12, 2005.
    Usage: v1.00 should ONLY be used with VC II v1.20.

    VIO2EDIT v1.10: Not officially released yet.
    You should only use v1.01+ Betas with the IGM's current
    January 2011 Non-Betas.  Donald.
=================================================================


Section 4:  Violet's Cottage II IGM Files Distribution:
------------------------------------------------------------

  Official distribution was done October 12th, 2005 using
  VIO2ED10.ZIP archive, for VIO2EDIT v1.00.

  http://www.filegate.net/camelot/lordfile/vio2ed10.zip
  http://camelot.legendarydragons.com/LordApps/vio2ed10.zip

  ** VIO2EDIT v1.10 has not been officially released yet.

  ** VIO2EDIT's next official release will be done whenever
     the current work on the IGM has been completed.
------------------------------------------------------------

Official release program archives are posted here:

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

  Beta download links:
  ---------------------
  http://camelot.legendarydragons.com/IGM-Beta/vio2edit.zip
  -- Only contains the jackedit.* files.

  http://camelot.legendarydragons.com/IGM-Beta/vc2-work.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/lgc-edit.zip
      Primary distribution point.

2) The Nightfallgames.com web-site:  Hosted by Michael Everett.
   http://www.nightfallgames.com/files/Igms/lgc-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/

   Currently, as of 09/21/2008, I am unable to post any new
   files to the FTP:://legendarydragons.com/lord/ sub-directories,
   so none of its files are current beyond July 2007.  I'm
   waiting for this situation to be resolved.

5) Shannon Talley's Fidotel BBS server.  Kept up-to-date every
   few months by me.
===================================================================


Section 5:  Violet's Cottage II Files Hyperlinks:
------------------------------------------------------------

  VIO2EDIT v1.00 download links:
  ** Officially released on October 12th, 2005.
  -----------------------------------------------------
  (1)  http://camelot.legendarydragons.com/LordApps/vio2ed10.zip
       - Castle Camelot Lordapps sub-directory.

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

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

VIO2EDIT Files:  Copyright 2005-2011 by Donald Tidmore.
=============================================================


Section 6:  Source Code Distribution Notes:  {Added 06/03/08}
------------------------------------------------------------

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

http://camelot.legendarydragons.com/IGM-Code/vc2-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
VIO2EDIT.  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: Violet's Cottage II Files Copyright Information:
----------------------------------------------------

The Violet's Cottage II IGM was created on January 26th, 2004,
and is a complete recreation of Trevor Herndon's Violet's
Cottage IGM done with his full consent and approval.  I provide
all support for Trevor's programs.  I have also recreated his
Love Shack IGM;  and have recreated the Armoury and Weapons Shop
from his Castle of LORD IGM, which were incorporated into my
Hiding In The Shadows IGM, v3.00 in 2007.

VIOLET2.EXE v1.00 was released on Dec. 25th, 2004.
VIOLET2.EXE v1.20 was released on Oct. 12th, 2005.

The IGM was put back into development in late May 2008.
VIO2EDIT development was resumed in early June.
------------------------------------------------------------

VIOLET2.EXE:   Copyright 2004-2011 by Donald Tidmore.

VIO2EDIT.EXE:  Copyright 2005-2011 by Donald Tidmore.

This file, along with the rest of Violet's Cottage II IGM files,
is Copyright 2004-2011 by Donald Tidmore.
=============================================================

The VIO2EDIT.TXT file was created on August 04th, 2005.

This docs file was completely rewritten on Jun. 03rd, 2008.

End of VIO2EDIT.EXE documentation.
----------------------------------------
           
Revised on:   December 27, 2010 at 06:00 pm.
  
