DOORMUD v0.99    [Synchronet/Win32]
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
Copyright 2003 Evan Elias.

This is the Sysop Documentation file for DoorMUD.  This document is also
available online in hypertext format at http://dmud.doormud.com/sysdocs.html ,
complete with configuration screenshots!  You may find that version of the
docs to be easier to use.


This version of DoorMUD is a special Win32 build that will only run on the
Synchronet BBS software.  This version will not run on any other BBS software,
and does not have a local mode.    


Upgrading from a previous Win32 version:
   If you already have a previous Windows version of DoorMUD installed on your
   BBS, upgrading to the newest release is easy.  Simply unzip the new archive
   to your old DoorMUD directory, overwriting older files as needed.  

   If you installed the World Editor in v0.98, you must also download 
   WORLD099.ZIP to upgrade your copy of the World Editor. 


Upgrading from the DOS version to the Win32 version:
   If you currently have a DOS version of DoorMUD installed on your BBS, and
   you want to upgrade to this Win32 version, please consult UPGRADE.TXT.


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


Introduction 
~~~~~~~~~~~~
DoorMUD: Land of the Forgotten is a text-based role-playing game of massive
proportions.  In an ancient, war-torn land, the demonic Warmaster of Chaos
lies locked away in a dungeon deep underground. His minions are forming armies
on the surface, preparing for the day when an evil champion will set him free.
Meanwhile, the holy forces of Order have finally forged a weapon capable of
slaying the Warmaster, but first they must find a hero powerful enough to 
wield the mighty blade. Thus, players are presented with a choice: Will they
strive to kill the Warmaster and bring Order to the land? Or shall they free
the Warmaster and doom the world to its destruction?

DoorMUD is an affordable, high-quality MUD (multi-user dungeon) that will run
on any BBS software capable of running doorgames. DoorMUD features fast-paced
real-time combat, excellent multinode interaction, a high-powered command
interface and a huge game world with over 2100+ rooms for players to explore.
It is actively supported, with new versions coming out on a regular basis.  A
World Editor add-on is also now included in the registered version, allowing
Sysops to modify the game world and create your own new dungeons, quests,
artifacts, and more!


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


Contents
~~~~~~~~
1. Support features
2. Disclaimer
3. Setup
4. Configuration options
5. Registration
6. Misc


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


1. Support Features
~~~~~~~~~~~~~~~~~~~
- 32-bit Windows version made exclusively for Synchronet -- runs much faster
  than the DOS version, and allows for features such as inter-node paging.
- Real-time multinode interaction -- players can easily communicate with each
  other on-line, and can join up in teams to defeat more difficult monsters.
- Lots of innovative sysop-friendly features to make your life easier, 
  including automatic daily backups and the ability to un-do game resets.
- Demo version allows training up through level 7, allowing users to get a 
  good feel for the game. Registration for the basic version costs only $20.


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


2. Disclaimer - Agreement
~~~~~~~~~~~~~~~~~~~~~~~~~
Users of this program must accept the following:

DOORMUD is supplied as is.  The author disclaims all warranties, expressed or
implied.  The author assumes no liability for damages, direct or 
consequential, which may result from the use of DOORMUD.

You may not modify or disassemble this software, in whole or in part.  Use 
of decompilers, hex editors, bytecode modifiers, and similar programs on any
DOORMUD executable file is strictly forbidden, and voids your license to run
DOORMUD.

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


3. Setup
~~~~~~~~
In order to set up DoorMUD, perform the following steps:

Step 1:  Create a new directory just for DoorMUD, and copy all of the DoorMUD
         files to this directory.  (You may have already done this.)


Step 2:  Run SCFG by selecting BBS -> Configure in the Synchronet console. 
         Then go to External Programs -> Online Programs -> Games -> Available
         Online Programs, and hit the insert key.  Use "DoorMUD" for the 
         program name and internal code.  Now, configure DoorMUD as follows:

         ----------------------------------------------------------
          Name                       DoorMUD                      
          Internal Code              DOORMUD                      
          Start-up Directory         C:\SBBS\XTRN\DOORMUD   <<- Example only
          Command Line               dmud32                       
          Clean-up Command Line                                   
          Execution Cost             None                         
          Access Requirements                                     
          Execution Requirements                                  
          Multiple Concurrent Users  Yes                          
          Intercept I/O Interrupts   No                           
          Native (32-bit) Executable Yes                    <<- See note
          Modify User Data           No                           
          Execute on Event           No                           
          BBS Drop File Type         Synchronet      XTRN.DAT     
          Place Drop File In         Node Directory               
          Time Options...                                         
         +----------------------------------------------------------+

         Be sure to set the "start-up directory" to whatever directory you put
         your DoorMUD files in.

         When selecting the Synchronet XTRN.DAT dropfile type, set "use real 
         names" to "no" in order for inter-node paging to properly display a 
         user's alias.    

         The "Native (32-bit)" option is only available in Synchronet v3.10g 
         or later.  If you are using an older version of Synchronet, you MUST
         put dmud32 on the OS/2 Program List instead as described below in
         step 3.


Step 3:  If you are running Synchronet v3.10g or later, you can now exit SCFG
         and skip to step 4.

         Otherwise, you are running an older (pre-3.10g) release of Synchronet, 
         and must now manually tell the BBS to properly recognize DoorMUD as a
         native 32bit door.  In SCFG, select External Programs -> OS/2 Program
         List and hit the insert key on your keyboard.  Type "DMUD32" and then 
         hit enter.  Select "No" for the "Comm Port" toggle.  (This step is
         *required* for pre-3.10g Synchronet, so do not skip it!)
       
         Next, exit SCFG.  Be sure to then refresh the board's node/config 
         data in order for the game to appear on your BBS's menus.  You can do 
         this by hitting the stop button then the play button on the Synchronet
         telnet server.


Step 4:  Log on to your BBS with a Sysop account and enter the door.  The
         first time the Sysop (security level 90+ in Synchronet) enters the
         door, you will be prompted for your real name.  This is needed for
         registration purposes.  After doing this, the game is now completely
         set up and ready for your users to play.


Please note that there is no "local mode" for the Synchronet version of DoorMUD.
To play locally, use a telnet client to log onto your BBS, and play from your
BBS account.

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


4. Configuration Options
~~~~~~~~~~~~~~~~~~~~~~~~
If you enter the door with a Sysop account (security 90+), a special menu 
option will become available that allows you to configure the game's settings.

At the top of the Configuration screen, you will see your Pre-registration
Code.  This is used for registration purposes if you wish to purchase the full
version of the game.

From the Configuration screen, you can change the following game settings:

[F] Monster Fights per Day:  
       Controls how many monster fights a player gets per day.  Every time a
       player kills a monster, one monster fight is used up.  Once a player
       runs out of monster fights, they can still continue to kill more 
       monsters if desired, but they won't gain any experience or gold for it.
       The default is 35 monster fights per day, which will entertain an
       experienced player for about 15 to 25 minutes per day.  

[M] Maximum Accumulated Fights:
       Unlike most other doorgames, unspent monster fights in DoorMUD add up
       from day to day.  This way, your users do not have to play every single
       day in order to maintain a high ranking.  This setting controls how 
       many unused fights a player can accumulate; the default is 100.  It is
       recommended that you set it to about 3 times as high as the daily fights
       setting.  But if you wish to just turn off fight accumulation entirely,
       set it to the same number as the daily fights setting.

[R] Reset the game
       Totally resets the entire game, deleting all players and returning all
       items to their original location.  Please note that there is no need to
       select this option when you first install the door.

[U] Undo previous reset
       Restores the game files prior to the previous reset. This option is 
       only available if the game has been reset before.


If you have purchased the DoorMUD Professional add-on, additional config
options are also available.  Please see the DoorMUD Professional documentation
for information on these settings.


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


5. Registration
~~~~~~~~~~~~~~~
DoorMUD is shareware.  In the unregistered version, players may not advance 
past level 7, and can only explore about 700 of the 2100+ rooms in the game 
world.  If you register the game, your users can advance to any level
and can access the entire game world.  

Registration for the basic (4 line) version costs $20 US.  Registration now
includes a copy of the World Editor add-on program, which allows you to freely
modify and expand DoorMUD's game world!  Please see ADDONS.TXT for more
information.


HOW TO REGISTER ON-LINE:
-----------------------
Registering on-line is the fastest and most convenient method to purchase
DoorMUD.  Please see http://dmud.doormud.com/register.html for more information.



HOW TO REGISTER BY POSTAL MAIL:
------------------------------
1.  Print and fill out the registration form (REGISTER.TXT).  If you do not
    have a printer, you may handwrite the information.  Be sure to include
    your Pre-registration Code.  This can be found at the top of the
    Configuration screen (see part 4, above).  Copy it EXACTLY as it appears.
2.  Include a check or money order for $20 US.  If using a check, make it
    payable to "Evan Elias".
3.  E-mail RhythmNp@aol.com to inquire about the current registration mailing
    address.  Place your registration form and payment in an envelope and mail
    to this address.

If you pay with a personal check, please allow an extra week for the check to
clear.


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


6. Misc
~~~~~~~

User license:
  This version of DoorMUD allows up to 4 simultaneous users/nodes to play the
  game at once.  This should be sufficient for most hobbyist boards.  But if
  you run a larger MUD-oriented BBS, you may be interested in the DoorMUD 
  Professional add-on, which allows for up to 16 simultaneous users.  Please
  see ADDONS.TXT for more information.

Monster Fights:
  There is intentionally no setting to allow for unlimited monster fights.
  However, you can set the Daily Monster Fights setting as high as 1000 if
  desired, which would allow for 9+ hours of gameplay per day.  Setting it
  anywhere near this high is definitely NOT recommended though, unless you
  are using the DoorMUD Professional add-on to increase the experience point
  tables.  Otherwise, high Monster Fight settings will allow players to gain
  levels much too quickly.  In the basic version of DoorMUD, it is HIGHLY
  recommended that you leave the Monster Fights at the default setting of 35
  per day.

Automatic Backups:
  DoorMUD automatically makes backups of its vital data files on a regular
  basis, usually once per day.  If your data files ever become corrupted, 
  copy the three *.bak files (CREATURE.BAK, ITEM.BAK, CONFIG.BAK) over the
  *.dat files of the same name, to revert to the backups.  These backups are
  made just as a precaution; data file corruption is extremely rare.

USERINFO.TXT:
  This text file lists the real name of each user in the game, and shows how
  many days it has been since the user last played.  It is updated daily, when
  the game runs maintenance.  This is not a score file; it is intended to
  provide the Sysop with information as to which users are playing the game.

Local display windows:
  Unlike DOS doorgames, this 32-bit Windows version of DoorMUD does NOT create
  local display windows when users enter the game.  However, a "/window"
  command line option is available if you wish to have the program create a 
  DOS-style local display.  This may be useful if you wish to monitor your 
  users while they play DoorMUD.

Command-line options:
  There are currently 3 command-line options that can be used in the 32-bit
  version of DoorMUD.  They are as follows:

   /window          - Generates a local display window when dmud32.exe is run.
   /timeout x       - Sets how long the game waits, in minutes, before kicking
                      out an inactive user.  Valid range is 4 min to 10 min; 
                      default is 5 minutes.
   /nointro         - Prevents the game's ANSI intro screen from being 
                      displayed.

  To use these command-line options, simply modify the setting for DoorMUD's
  command line in Synchronet's configuration.  For example, instead of just
  being "dmud32", you might change the command line to "dmud32 /timeout 8".
  Don't forget, in older versions of Synchronet, you must refresh the nodes
  after exiting SCFG in order for new config changes to take effect.



Support:
-=-=-=- 
Please consult one of the following sources if you are having difficulty setting
up the game or if you have any questions, comments, ideas, etc --

 - Visit the official DoorMUD webpage:  http://www.doormud.com
 - E-mail the game's programmer:        RhythmNp@aol.com

The web page contains many resources for players and sysops alike.  You may
want to give the Sysop FAQ a look if you are having difficulty with the game.



Thank You's:
-=-=-=-=-=-
Beta testing   -- Kevin Brown, Barry Bogart, Bryan Housel, Jeff Miller
ANSI graphics  -- Outworld Arts
32-bit Doorkit -- Rob Swindell
Web Hosting    -- awphosting.com


<End of file>