Realm of Lore Player Database Editor Documentation:
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

IGM Utility:  Realm of Lore Player Database Editor (ROL2EDIT)
ROL2EDIT Author:  Donald Tidmore.

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

This program is dedicated to Paul Mullins and
Charlie Wardick.

Status: v1.10.  ** Officially released on Jul. 27th, 2008.

Compile Date:  July 27, 2008.

Docs update:   December 09, 2009.
============================================================


Section 1:  ROL2EDIT UPDATE NOTES:
------------------------------------------------------------

Realm of Lore is no longer compatible with the first official
version of ROL2EDIT.  You *MUST* be using v1.10 of ROL2EDIT
and v1.94+ Beta of the IGM.

** Requirements:  You *MUST* be using a ROLPLAY.DAT player
database file.  And you must be using v1.94+ of the IGM.

12/09/2009 note: Because ROL2EDIT was officially released last
in July 2008, it has one glitch now.  It won't allow you to set
Visits to IGM to the current maximum value of 25.  I plan to fix
that later this month possibly, or in January 2010.
---------------------------------------------------------------


Section 2:  ROL2EDIT Program Usage Notes:
------------------------------------------------------------

  Note:  For access to revise the LORD Player Number field,
  use the command ROL2EDIT /DEBUG to run the Player Database
  Editor utility.  This also applies to the Next LORD Game Day
  field.  ** READ the Warning about these two event's usage
  before using it!!  **
  ===========================================================

  ** Obtain copy of the ROL2ED11.ZIP distribution archive,
     and/or the ROL2EDIT.ZIP work archive.  ROL2ED11.ZIP was
     officially released on 07/27/2008;  online distribution
     was done on 07/29-30/2008.

     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.  Periodically,
     I will also update the Fidotel BBS's FTP Server with the
     newest official release and beta archives of my programs.

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

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

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

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

     If you're updating from one version of ROL2EDIT to a newer
     one, they all use the same ROL2EDIT.CFG file.  Its format
     will never change.  ROL2EDIT does not use RL-USAGE.TXT, or
     REALM2.CFG.  It also does not directly use ROLBACK.DAT.

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

  2) ROL2EDIT 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 TWO exceptions,
     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.

     (2) The Next LORD Game Day field is display-only.  It is
     used by the IGM's entry sequence in various ways.

     NOTES:   ROL.EXE is the ONLY program that is normally
     allowed to alter a player record's Player Number and Next
     LORD Game Day fields, in regards to the Realm of Lore 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, and/or the value of Next LORD Game Time.

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

     Do *NOT* mess with *EITHER* variable's 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 values *BEFORE* you try
     to change either the LORD Player Number or the Next LORD
     Game Day variable's value(s).

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

  3) When you exit ROL2EDIT, it will resave the ROLPLAY.DAT
     file so that any changes you made will be accessible to
     the IGM.

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

  ========================================================
  4) Deleting Database Records.  Added 02/28/2007.

  ROL2EDIT uses the Y 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 (ROLPLAY.DAT) that the IGM is creating.

  Once a record has been deleted in ROL2EDIT, 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 ROL2EDIT 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 ROL2EDIT usage.
=================================================================


Section 3:  ROL2EDIT DEVELOPMENT NOTES:
------------------------------------------------------------

    -- Initial development started on Apr. 11th, 2006.  (v1.00)
    -- First stage development ended on Nov. 19th, 2006.

    -- Second development cycle started Dec. 10th, 2006.
    -- Second stage development ended on Jul. 27th, 2008.

    -- Uses Dec. 09th, 2006 Player Database structure.
    -- ROL2EDIT v1.10 requires ROL v1.94+ Betas or ROL v2.00.

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

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


Section 3-B:  ROL2EDIT VERSIONS HISTORY:
------------------------------------------------------------
    ROL2EDIT v1.00: Officially released on Nov. 19th, 2006.
    Usage: v1.00 can ONLY be used with ROL betas prior to v1.94.

    ROL2EDIT v1.10: Officially released on Jul. 27th, 2008.
    Note: Can only be used with v1.95+ betas, and by v2.00.
=================================================================


Section 4:  Realm of Lore IGM Files Distribution:
------------------------------------------------------------

  Official distribution was done November 19th, 2006 using
  ROL2ED10.ZIP archive, for ROL2EDIT v1.00.

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

  ** NOT Usable with betas of ROL prior to v1.94 Beta.
  ** NOT usable under ANY circumstance with ROL v1.43/v1.44.
------------------------------------------------------------

  Official distribution was done Jul. 27th, 2008 using
  ROL2ED11.ZIP archive, for ROL2EDIT v1.10.

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

Realm of Lore v2.00 has not been officially released yet,
as of December 09, 2009.

Official release program archives are posted here:

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

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

  http://camelot.legendarydragons.com/IGM-Beta/rol-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:  Realm of Lore Files Hyperlinks:
------------------------------------------------------------

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

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

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


  ROL2EDIT v1.10 download links:
  ** Officially released on Jul. 27th, 2008.
  -----------------------------------------------------
  (1)  http://camelot.legendarydragons.com/LordApps/rol2ed11.zip
       - Castle Camelot Lordapps sub-directory.

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

  (3) BBS Archives server, hosted by Mike Ehlert.
      See Lord_Igms directory for ROL200.ZIP, and
      see Lord_Utils directory for ROL2ED11.ZIP archives.
  ----------------------------------------------------------

      { Info Added 07/30/2008: }
  Note: When it is officially released, Realm of Lore
  v2.00 will be available from these three primary sources:

  (1)  http://camelot.legendarydragons.com/LordApps/rol200.zip
       - Castle Camelot Lordapps sub-directory.

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

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

  ROL200.ZIP will contain the updated documentation and program
  files used by the ROL2EDIT.EXE program.  As well as those for
  the CONVLORE and RLMEDIT utilities also used by the IGM.
  ----------------------------------------------------------

ROL2EDIT 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 Realm of Lore programs, you may download the igm's
source code archive from the Castle Camelot web-site.

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

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

Note: The TechnoJock's Gold Toolkit, which is no longer
supported or available for purchase online, is used to make
ROL2EDIT.  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: Realm of Lore Files Copyright Information:
----------------------------------------------------
ROL.EXE:      Copyright 2004-2010 by Donald Tidmore.
              Copyright pre-2004 by Paul Mullins.

RLMEDIT.EXE:  Copyright 2005-2010 by Donald Tidmore.

RLSETUP.EXE:  Copyright 2004-2010 by Donald Tidmore.

CONVLORE.EXE: Copyright 2006-2010 by Donald Tidmore.

ROL2EDIT.EXE:  Copyright 2006-2010 by Donald Tidmore.

End of ROL2EDIT.EXE documentation.
----------------------------------------
           
This file, along with the rest of Realm of Lore IGM files,
is Copyright 2004-2010 by Donald Tidmore.

All ROL2EDIT.*, CONVLORE.*, RLSETUP.*, RLMEDIT.* files are
Copyright 2006-2010 by Donald Tidmore.

=============================================================

07/30/08 edit: Deleted invalid references to Gem Trader IGM's
Jackedit and Gemtr250 archive/program files.  Corrected
versions of the ROL2ED11.ZIP distribution archive will be
posted to the Castle Camelot web-site soon.
-------------------------------------------------------------

ROL2EDIT.TXT was created on Apr. 11th, 2006.

The ROL2EDIT.txt file was completely rewritten on Feb. 28, 2007.

Rol2edit.txt was rewritten for v1.10 on Dec. 18th, 2007.

Revised on:   December 09, 2009 at 03:53 am.

