The Forest Outhouse - FO2EDIT.TXT

Player Database Editor Utility program docs

FO2EDIT.EXE Status:  v0.72 beta.  ** January 2011 Beta.

Compile Date:  December 31, 2010.

Docs Update:   December 31, 2010.

Requirements: Can ONLY be used with OUTHOUSE.EXE program
     released on/after Apr. 24th, 2009 due to player database
     file structure revisions.  Not usable under *ANY*
     circumstance with v2.50 or older versions of the IGM.
--------------------------------------------------------

For use when utility is in beta development:

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

Notes: Includes source code file for FO2EDIT utility.

FO2EDIT.EXE is currently based on a Player Database structure
revised on 04/24/2009.  It will now only work with compilations
of OUTHOUSE.EXE made on/after 04/24/2009.  It can NOT be used
with any OH2PLAY.DAT files that are dated before that date.

April player database structure changes summary:
    Apr. 17, 2009: Rewrote entire layout of database file.

    Apr. 24: Renamed variable used for Forest Fights IGM stat.
             Added & implemented usage of Kids Lost IGM stat.
============================================================


FO2EDIT Author:  Donald Tidmore.

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


FO2EDIT can not be used with older versions of Forest Outhouse.

Work started on development of new OUTHOUSE.EXE and FOSETUP.EXE
program files on Apr. 13th, 2009, using new IGM Player Database
format and new IGM Config file format.
=============================================================


Dedication:  FO2EDIT.EXE is dedicated to Paul Romine.
============================================================


Section 1:  FO2EDIT UPDATE NOTES:
------------------------------------------------------------

Caveat:  This program is *NOT* usable in any circumstances
with any version of Forest Outhouse prior to v2.51.5 Beta.

** Requirements:  You *MUST* be using a OH2PLAY.DAT player
database file.  And you MUST be using a OUTHOUSE.EXE program
which is dated on/after Apr. 24th, 2009.  The same applies to
usage of FOSETUP.EXE.
---------------------------------------------------------------


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

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

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

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

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

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

  2) FO2EDIT 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:   OUTHOUSE.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 FO2EDIT.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 FO2EDIT to do so *ONLY* if you
     are ABSOLUTELY sure that you know what you are doing!!!
     ---------------------------------------------------------

  3) When you exit FO2EDIT, it will resave the OH2PLAY.DAT
     file so that any changes you made will be accessible to
     the IGM.  Note that FO2EDIT will never access, or make
     changes to the Player Database Backup file OH2BACK.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 FO2EDIT 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 FO2EDIT is being executed
  in Debug Mode.

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

  FO2EDIT 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 OH2PLAY.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 FO2EDIT, 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 FO2EDIT 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 FO2EDIT 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 FO2EDIT, without changing
    a single value, the editor utility will still resave the
    OH2PLAY.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 FO2EDIT usage.
=================================================================


Section 3:  FO2EDIT DEVELOPMENT NOTES:
------------------------------------------------------------
    -- Initial development started on Apr. 17th, 2009.
       FO2EDIT.PAS was created on 04/17/2009.

    -- Requires you to have a current OH2PLAY.DAT file,
       that was made by Forest Outhouse version 2.53.

    Distributed inside the FO2-EDIT.ZIP and OH2-WORK.ZIP archives.

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


Section 4:  The Forest Outhouse 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/fo2-edit.zip
  -- Only contains the OUTSEDIT.* files.

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

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

{ Not written yet }
===========================================================


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

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

2) http://www.nightfallgames.com/files/Igms/fo2-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.  Dennis Collins
has unlimited access to all of my source code since he helps
me debug the programs, when I run into problems.  And members
of my beta testers team also have permission to access and
use all of my source code files, within reason.

The FO2EDIT.* 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 Forest Outhouse programs, you may download the igm's
source code archive from the Castle Camelot web-site.

http://camelot.legendarydragons.com/IGM-Code/oh2-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 the development
of LORD Cavern, Outlands Tavern, and RHPTest/LordType currently.

Periodically he also finds and fixes problems in my other LORD
programs when I get stumped by something and need help.
---------------------------------------------------------------

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

Regarding any aspects of the Forest Outhouse IGM that are from
LORD Cavern, you also will need to have permission from Jason
Brown before you can use those coding processes in your own
program.  That is especially true if it involves the RHP Library
programming.

Notes: The modified DDIGM tool-kit source code unit files used
by this IGM are inside the OH2-SRC2.ZIP archive, which is
inside OH2-CODE.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
FO2EDIT.  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: Forest Outhouse Files Copyright Information:
----------------------------------------------------

OUTHOUSE.EXE and related programs:
OUTHOUSE.EXE: Copyright 2002-2011 by Donald Tidmore.

FOSETUP.EXE:  Copyright 2003-2011 by Donald Tidmore.
    Includes the copyright protection used by OH2SETUP.EXE.

FO2EDIT.EXE:  Copyright 2009-2011 by Donald Tidmore.
=====================================================

The FO2EDIT.TXT file was created on Apr. 19th, 2009.

Revised on:   December 31, 2010 at 06:00 pm.

