The Gateway - GW2EDIT.TXT

Player Database Editor Utility program docs

GW2EDIT.EXE Status:  v0.34 Beta.  ** January 2011 Beta.

Compile Date:  December 27, 2010.

Docs Update:   December 27, 2010.

Requirements: Can ONLY be used with GATEWAY.EXE program
              released on/after Nov. 02, 2009.

GW2EDIT.EXE is not usable under *ANY* circumstance with
all older versions of The Gateway IGM.  It can only be
used with version 1.31+ Betas worked on in 2009 or in 2010.
--------------------------------------------------------

For use when utility is in beta development:

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

Notes: Includes source code file for GW2EDIT utility.

GW2EDIT.EXE is currently based on a Player Database structure
created on 11/02/2009.  It will now only work with compilations
of GATEWAY.EXE made on/after 11/02/2009.  It can NOT be used
with any GATEPLAY.DAT files that are dated before that date.
============================================================


GW2EDIT Author:  Donald Tidmore.

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


GW2EDIT can not be used with older versions of The Gateway,
covering versions 1.0 through v1.3.

Work started on development of new GATEWAY.EXE and GWSETUP.EXE
program files in October 2009.  The IGM at that time changed
to a new Config file structure, and a new Player Database
file structure.
=============================================================


Dedication:  GW2EDIT.EXE is dedicated to Christopher Gosse.
============================================================


Section 1:  GW2EDIT UPDATE NOTES:
------------------------------------------------------------

Caveat:  This program is *NOT* usable in any circumstances
with any version of The Gateway prior to v1.31+ Beta.

** Requirements:  You *MUST* be using a GATEPLAY.DAT player
database file.  And you MUST be using a GATEWAY.EXE program
which is dated on/after Nov. 02, 2009.  The same applies to
usage of GWSETUP.EXE.
---------------------------------------------------------------


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

  ** Obtain copy of gw2-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 gw2-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) GW2EDIT Config:  Revised 12/10/2009

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

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

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

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

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


Section 3:  GW2EDIT DEVELOPMENT NOTES:
------------------------------------------------------------
    -- Initial development started on Dec. 10th, 2009.
       GW2EDIT.PAS was created on 12/10/2009.

    -- Requires you to have a current GATEPLAY.DAT file,
       that was made by The Gateway version 1.31+.

    Distributed inside the gw2-edit.ZIP and GATEWORK.ZIP archives.

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


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

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

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

5) The Fidotel BBS web-site.  Run by Shannon Talley.
   Will not always have the most up-to-date files.
   http://www.fidotel.com/.  You have to be a member to
   access its files database.
===================================================================


Section 5:  The Gateway Files Hyperlinks:
------------------------------------------------------------

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


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

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

2) http://www.nightfallgames.com/files/Igms/gw2-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 GW2EDIT.* 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 Gateway programs, you may download the igm's
source code archive from the Castle Camelot web-site.

http://camelot.legendarydragons.com/IGM-Code/gatecode.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, The Gateway, 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 Gateway IGM that are based on
the RHP Library Language, you MUST have permission from Jason
Brown and myself before you can use those coding processes in
your own program.  The only exception is Dennis Collins who
has adapted the RHP Language for usage in his unfinished and
unreleased Sorcerer door game and igms for it.  Most of those
igms are based on my existing DOS LORD IGM programs.

Notes: The modified DDIGM tool-kit source code unit files used
by this IGM are inside the GateSrc2.ZIP archive, which is
inside GATECODE.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
GW2EDIT.  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: The Gateway Files Copyright Information:
----------------------------------------------------

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

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

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

The GW2EDIT.TXT file was created on Dec. 10th, 2009.

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

