The Outlands Skeleton - OT20EDIT.TXT
Player Database Editor Utility program docs

OT20EDIT.EXE Status:  v0.85 Beta    ** January 2011 Beta

Compile Date:  December 25, 2010.

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


For use when utility is in beta development:

    http://camelot.legendarydragons.com/IGM-Beta/ot20edit.zip

Notes: Includes source code file for OT20EDIT utility.

Program based on OUTSEDIT v1.00 utility.  Modified to work
with the OUTSPLAY.DAT file used by TAVERN.EXE program.
============================================================


OT20EDIT Author:  Donald Tidmore.

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


OT20EDIT v0.85 Beta is ONLY for use with the Outlands Skeleton
Tavern IGM project, which is in progress.  Its a framework
for use later this year in creating Outlands Tavern v2.00,
which uses the ANGEL Tool-kit.
=============================================================


Dedication:  12/03/2007: This utility is dedicated to Dennis
Collins for his help in rewriting Outlands Tavern so it won't
use arrays, and for rewriting the RHP Library Unit.  So that
it won't screw up multiplication and division formulas.  It
is also dedicated to Jason Brown, who created this IGM.
============================================================


Section 1:  OT20EDIT UPDATE NOTES:
------------------------------------------------------------

Caveat:  This program is *NOT* usable in any circumstances
with any old or current version of OUTLANDS.EXE.

** Requirement:  You *MUST* be using a OUTSPLAY.DAT player
database file to use OT20EDIT.exe v0.50+ Betas.
---------------------------------------------------------------


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

  ** Obtain copy of OT20EDIT.ZIP from one of my official
     distribution sites, and use it.  Program will also be
     available in the TAVEWORK.ZIP archive.

     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.
     Files will also be available eventually 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 OT20EDIT.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) OT20EDIT Config:  Revised 06/24/2008

     During the TAVERN INSTALL process, TAVERN.EXE will
     automatically create a OT20EDIT.CFG file for the user, using
     the location that TAVERN.EXE is being executed from.

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

     The program does not use the OUTSBACK.DAT player database
     backup file, that is in use by the TAVERN.EXE program.

  2) OT20EDIT 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 MAJOR
     exceptions, and several MINOR 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.

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

     (2) The Drunk Meter setting can contain a negative number
     at times during NORMAL usage of the IGM.  Therefore it is
     BEST that you NOT alter this value, unless you are SURE you
     know what you are doing.

     Reasons:  (a) One negative value signifies that the player
     is Imprisoned in the Dungeon.  (b) Another negative value
     signifies that the player is Asleep in a Tavern Room.
     (c) It is best to let the IGM set the value of this variable.

     (3) The Under_Attack variable should ONLY be changed by the
     IGM, since it is the only program that knows for sure if the
     player record being edited is in use or not.

     Exception: Players can ONLY be Under Attack if they are
     sleeping in a Tavern Room.  If they are listed as being
     in the Dungeon, the New Day process will fix the invalid
     Captured variable. The Under Attack variable is not used
     by the igm's Kill Dungeon Prisoner process since it works
     very fast, whereas a Room Fight could last for a few
     minutes before it ends.   {rewrote 01/17/10}

     (4) The Sleeping variable can be reset by the user.  But
     unless the player has a matching OUT file indicating that
     he/she is asleep in The Outlands Skeleton, setting SLEEPING
     to TRUE for example, may not have any effect on the IGM.

     Exception: Players can ONLY be listed as "Asleep in IGM?"
     if they are sleeping in a Tavern room.  When New Day for
     Player runs, if the Sleeping VAR is TRUE and the Captured
     VAR is also TRUE, the Captured VAR will be reset to False.

     ** Be careful about setting Captured to TRUE.  Doing so
     will toss the player into the Dungeon immediately upon
     their next usage of the IGM.  Which won't make them happy.

    -----------------------------------------------------------
     NOTES:   TAVERN.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.

     Standard settings currently in use for the Drunk Meter
     include negative values when the player is Sleeping in
     the IGM, or they are Imprisoned in the Dungeon.  The editor
     will ONLY allow values between -110 and 200 for the field.

     TAVERN.EXE is the ONLY program that should normally be
     used to modify the value of the Drunk Meter field.  Using
     OT20EDIT.EXE for this purpose is the only exception.

     The user *MUST* use extreme caution in doing *ANY* changes
     to either field while using the OT20EDIT.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 the LORD Player Number variable for anyone.

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

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

  ------------------------------------------------------------
  4) Deleting Database Records.       {Rewrote 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.

  OT20EDIT's existing Delete Player Record option has been
  rewritten so that it is only usable when OT20EDIT is run
  in Debug Mode.  This feature should NEVER be used unless
  the user has a VALID reason to delete a player's record.
                   
  This IGM only writes records to the OUTSPLAY.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.
  --------------------------------------------------------

  OT20EDIT 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.  Which is only run ONCE per day.

  Since this IGM has two modes where players spend the "night"
  in the Tavern - either Asleep in a Room or Imprisoned in
  a Dungeon Cell, records from the previous day are processed
  to determine if they should be rewritten to the new Player
  Database File that Save_Player_Data creates.

  Once a record has been marked as "DELETED" in OT20EDIT, 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.

  OT20EDIT does *NOT* do anything whatsoever to OUT files that
  a player may have in use in the LORD directory.

  Records marked as "* DELETED *" are skipped by SAVE_PLAYER_DATA
  when it recreates a new player database file.

  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 OT20EDIT will finish the
  Delete Record process.  Users MUST use either the NO option or
  CANCEL option if they wish to cancel the deletion process.
-----------------------------------------------------------------

5) Important reminders:         {Added 01/17/2010}

If OT20EDIT is used to change a player's SLEEPING status to YES,
this setting will be IGNORED by the IGM when it is next used
by that player if there is no corresponding OUT file in the LORD
directory that says "is Sleeping in The Outlands Skeleton."  So if
you want a player to be Asleep in the IGM, remember that you
also have to make sure there is a corresponding OUT file for
the player.

If OT20EDIT is used to change a player's IMPRISONED status to YES,
this setting will be IGNORED by the IGM when it is next used
by that player if there is no corresponding OUT file in the LORD
directory that says "is Imprisoned in The Outlands Skeleton's
Dungeon".  So if you want a player to be Imprisoned in the
Dungeon, remember that you also have to make sure there is a
corresponding OUT file for the player.

The Sleeping stat in a Player Record is always set to FALSE
by the IGM if the player entering TAVERN.EXE doesn't have an
OUT file which indicates that they have been Sleeping in an
Outlands Skeleton Tavern Room.

The Imprisoned stat likewise is always set to FALSE by the IGM
if the player entering TAVERN.EXE doesn't have an OUT file which
indicates that they are Imprisoned in an Outlands Skeleton
Dungeon Cell.
---------------------------------------------------------------

6) Special Note.  If OT20EDIT 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}
-----------------------------------------------------------------

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


Section 3:  OT20EDIT DEVELOPMENT NOTES:
------------------------------------------------------------
    OutsEdit v1.00 Information:
    -- Initial development started on Nov. 29th, 2007.
    -- First development cycle was ended on Dec. 28th, 2007.
    (Info for OUTSEDIT is listed because OT20EDIT is based
    upon that program.)

    OT20EDIT.EXE program created on May 10th, 2008, since I
    realized its going to be needed while I work on the
    TAVERN.EXE project.

    -- Requires you to have a current OUTSPLAY.DAT file,
       that was made by Outlands Skeleton v0.10 Beta or a
       later version of the IGM.  This program can *NOT* be
       used by any earlier versions of the IGM.

    Distributed inside the OT20EDIT.ZIP official release archive;
    or inside the OT20EDIT.ZIP and TAVEWORK.ZIP archives.

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

OUTSEDIT is *NOT* usable with The Outlands Skeleton, and
OT20EDIT likewise is *NOT* usable with The Outlands Tavern.
Each IGM has its own dedicated set of igm data files.
=================================================================


Section 4:  The Outlands Skeleton IGM Files Distribution:
------------------------------------------------------------

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

Official release program archives are posted here:

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

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

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


Section 5:  Outlands Skeleton Files Hyperlinks:
------------------------------------------------------------

Official download links for OT20EDIT.EXE v0.85 Beta:  (NONE)
-----------------------------------------------

No official version is available yet.  I may never release one
for this program.  Its only for short-term usage, and will
eventually be replaced by an updated OUTSEDIT.EXE program.
-----------------------------------------------------------

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

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

v1.5:  http://www.filegate.net/camelot/lordfile/outs15.zip
       -- v1.5 was officially released on Jan. 01, 2004.

v1.5a: http://www.filegate.net/camelot/lordfile/outs15a.zip
       -- IGM was re-released as v1.5a on Jan. 05, 2004.

v1.6:  http://www.filegate.net/camelot/lordfile/outs16.zip
       -- Released officially on June 11th, 2005.
----------------------------------------

v1.8:  Has not been finished yet.  Is still being worked on
       by me and by Dennis Collins.

v2.0:  ANGEL-based version of Outlands Tavern.  I started
       its development on May 05th, 2008.
===========================================================


Section 6:  Source Code Distribution Notes:  {12/19/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 OT20EDIT.* 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 Outlands Skeleton programs, you may download the igm's
source code archive from the Castle Camelot web-site.

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

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 its development.
---------------------------------------------------------------

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 Outlands Skeleton, before you can legally use
any of the source code files used by this IGM.
-----------------------------------------------------------

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
OT20EDIT.  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: Outlands Skeleton Files Copyright Information:
----------------------------------------------------
TAVERN.EXE:  Copyright 1995-2002 by Jason Brown.
             Copyright 2002-2010 by Jason Brown and Donald Tidmore.

   Note: The program was created in 2008, but I consider it to
         be fully protected under the original IGM's copyright.

OT20EDIT.EXE:  Copyright 2008-2010 by Donald Tidmore.

End of OT20EDIT.EXE documentation.
============================================================

** The OT20EDIT.PAS, OT20EDIT.EXE, OT20EDIT.DIZ, and
   OT20EDIT.TXT program files were created on May 10th, 2008.  **

OT20EDIT.TXT was created on May 10th, 2008.

Revised on:   December 25, 2010 at 07:00 pm.

