home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-385-Vol-1of3.iso / d / dnd29c4.zip / DOC.ZIP / SYSOP.DOC < prev   
Text File  |  1993-01-08  |  24KB  |  478 lines

  1.  
  2.      DNDBBS Documentation                                           Page 1
  3.  
  4.      Table of contents                                              Page
  5.      -----------------                                              ----
  6.      1.0  Hardware requirements . . . . . . . . . . . . . . . . . . . 2
  7.      2.0  File distribution . . . . . . . . . . . . . . . . . . . . . 2
  8.      3.0  Modem settings  . . . . . . . . . . . . . . . . . . . . . . 2
  9.      4.0  Communications device driver  . . . . . . . . . . . . . . . 2
  10.      5.0  Console ansi support  . . . . . . . . . . . . . . . . . . . 3
  11.      6.0  Command line options  . . . . . . . . . . . . . . . . . . . 3
  12.      7.0  Dndbbs as a single user program . . . . . . . . . . . . . . 4
  13.      8.0  Problem determination . . . . . . . . . . . . . . . . . . . 4
  14.      9.0  Configuration problems  . . . . . . . . . . . . . . . . . . 5
  15.      10.0 Setup instructions  . . . . . . . . . . . . . . . . . . . . 5
  16.      11.0 Configuring instructions  . . . . . . . . . . . . . . . . . 5
  17.      12.0 Operating dndbbs  . . . . . . . . . . . . . . . . . . . . . 6
  18.      13.0 Modem communications  . . . . . . . . . . . . . . . . . . . 7
  19.      14.0 Configuring for communications ports  . . . . . . . . . . . 7
  20.      15.0 Door information and nodes  . . . . . . . . . . . . . . . . 7
  21.      16.0 Door batch files  . . . . . . . . . . . . . . . . . . . . . 8
  22.      17.0 System environment  . . . . . . . . . . . . . . . . . . . . 8
  23.      18.0 Files used  . . . . . . . . . . . . . . . . . . . . . . . . 9
  24.      19.0 Compiling instructions  . . . . . . . . . . . . . . . . . . 9
  25.      20.0 Rbbs door file structure information  . . . . . . . . . . . 10
  26.  
  27.      DNDBBS Documentation                                           Page 2
  28.  
  29.      1.0  Hardware requirements
  30.      --------------------------
  31.      The  adventure system  requires  an IBM (or compatible) PC, XT, or AT,
  32.      dos 4.0  or  higher,  serial port,  hayes  smartmodem (or compatbile),
  33.      minimum  of 640k memory,  an 80 column color monitor,  and 10 megabyte
  34.      fixed disk drive with at least one megabyte of free disk storage.
  35.  
  36.      2.0  File distribution
  37.      ----------------------
  38.      The adventure system is distributed on  Executive-PC Bbs,  data number
  39.      1-414-789-4210,  in file dnd29c4.zip containing all  executable files,
  40.      documentation, data, source, and  help files.  You must use the PKWare
  41.      utility to separate the programs from the compressed .zip files.
  42.  
  43.      3.0  Modem settings
  44.      -------------------
  45.      Dndbbs  can autoanswer the  modem by  receiving  the response ring and
  46.      returning the command ata,  or by receiving  the response connect then
  47.      the modem speed (i.e. connect 2400). This way the modem can autoanswer
  48.      with s0=1 or  with s0=0  (modem register s0 sets the number of rings).
  49.      Dndbbs configures serial ports for 300 up to 38,400 baud at no parity,
  50.      eight data bits,  and one stop bit (n,8,1). The initial modem settings
  51.      should be one of these commands:
  52.  
  53.      Modem initialization string 1: atm0e0q0v1x1
  54.  
  55.      m0     --   speaker off
  56.      e0     --   do not echo commands
  57.      q0     --   enable result codes
  58.      v1     --   verbose result codes
  59.      x1     --   extended result codes
  60.  
  61.      Modem initialization string 2: atm0e0q0v1x1&c1&d2
  62.  
  63.      &c1    --   carrier detection
  64.      &d2    --   DTR detection
  65.  
  66.      Modem initialization string 3: atm0e0q0v1x1&c1&d2s0=1Ss=255
  67.  
  68.      s0=1   --   autoanswer on ring one
  69.      s2=255 --   disable escape codes
  70.  
  71.      4.0  Communications device driver
  72.      ---------------------------------
  73.      Dndbbs can access most communications  device drivers for modem input,
  74.      output and initializing. Normally all you need to do is put the device
  75.      driver  statement  in your  config.sys file and reboot  to install the
  76.      port driver.  The  fossil  (fido/opus/seadog standard interface layer)
  77.      driver distributed as x00.sys is required to  be placed  in config.sys
  78.      with  the statement  device=x00.sys,  or if  you are  using more ports
  79.      (up to a maximum of eight),  use the statement  device=x00.sys 2, etc.
  80.  
  81.      DNDBBS Documentation                                           Page 3
  82.  
  83.      5.0  Console ansi support
  84.      -------------------------
  85.      Dndbbs sends color code changes to the ansi.sys device driver. This is
  86.      done by calling the basic interrupt function. The ansi driver is found
  87.      on  your dos disk.  Install the  driver  by placing the program on the
  88.      boot directory, add the statement device=ansi.sys into the  config.sys
  89.      file then reboot. Desqview users  should  put the statement dvansi.com
  90.      in the current dndbbs  partition.  The  ansi.sys driver is distributed
  91.      with dndbbs.  The vdisk.sys device should be installed for a small ram
  92.      disk of 16k and selected in the dndcnfg files variables.  Vdisk.sys is
  93.      only required for the ram disk option if you are using  multinodes for
  94.      message transfers between nodes by using the message work files.
  95.  
  96.      Example contents of config.sys:
  97.  
  98.      files=20
  99.      buffers=8
  100.      device=ansi.sys
  101.      device=vdisk.sys s:16
  102.  
  103.      Dndbbs can also utilize the enhanced ansi code as stated by the avatar
  104.      device driver specification. The driver included for using these codes
  105.      codes are zavt.sys and zavtnk.sys.  The zavtnk file has  the same ansi
  106.      codes  without  keyboard  redefinition code parsing.  When  the config
  107.      options Prompt For Avatar, and Detect Remote Avatar are selected, then
  108.      dndbbs will use local avatar code sequences.  Dndbbs  will also detect
  109.      remote avatar if these options are selected. Example Avatar driver is,
  110.      device=zavtnk.sys.
  111.  
  112.      6.0  Command line options
  113.      -------------------------
  114.      The  command line options  are  parameters you type after  the command
  115.      dndbbs  at the dos prompt.  If there  are  any  parameters at all, the
  116.      first must  be the node number.  The node number  must be in the range
  117.      from 0 to 9 or A to Z. All command line options should be separated by
  118.      a space. There are six options: [node],  local,  bbs, bypass, disable,
  119.      and name. Bbs starts the bulletin board service. Local starts the game
  120.      without modem communications. Bypass skips the startup screen. Disable
  121.      prevents dm commands or dm logins from being entered.  Name starts the
  122.      dndbbs with the username in quotes without being required to enter the
  123.      user's password.  The last two optional parameters are for over-riding
  124.      the communications port number specified in the configure modem screen
  125.      variables and  over-riding  the amount of time the user can be online.
  126.      The port parameter is /p:n where n is replaced with the alternate port
  127.      number. The time parameter is /t:n where n is replaced with the amount
  128.      of time the user can be online in minutes.
  129.  
  130.      Examples starting dndbbs:
  131.  
  132.      dndbbs bbs
  133.      dndbbs local
  134.      dndbbs 1 bypass
  135.      dndbbs c local name="uzernaym"
  136.      dndbbs bbs /p:1 /t:30
  137.  
  138.      DNDBBS Documentation                                           Page 4
  139.  
  140.      7.0  Dndbbs as a single user program
  141.      ------------------------------------
  142.      To start the adventure at your computer without a modem or serial port
  143.      type dndbbs local and you  will be able to enter the program from your
  144.      keyboard. When started locally you  are not required to operate dndbbs
  145.      as a bbs, need to  have a modem,  or need the fossil driver installed.
  146.  
  147.      8.0  Problem determination
  148.      --------------------------
  149.      The  modem does not  answer the phone.  This is  probably because  the
  150.      modem  is not initializing correctly. Try rebooting and  then starting
  151.      the program.  Try initializing the  modem with  another communications
  152.      program.  If none of these work then  your modem might not support the
  153.      hayes  command set.  When you start dndbbs, the fossil is initialized,
  154.      then  the opening  screen  appears.  The  status indicator  will  show
  155.      Waiting for Calls if  the modem has initialized correctly.
  156.  
  157.      If the status indicator shows Reset Timeout or Init Timeout this means
  158.      the modem has not sent ok back to dndbbs and  the modem might not have
  159.      initialized properly.  In this case dndbbs  continues normally anyway.
  160.  
  161.      Most users  do not  increment the files= statement  in config.sys when
  162.      installing dndbbs for the  first time.  Dndbbs uses sixteen files  for
  163.      its own use. Dos uses four files. Adjust  the  files= statement in the
  164.      config.sys file to 20 or more. The increased files will go into effect
  165.      when you reboot.
  166.  
  167.      The message Out Of Memory,  or Program To Large To Load during exiting
  168.      to edit, dndcnfg, or dndedit  from dndbbs opening screen,  or from the
  169.      dnd game indicates that the program cannot load the secondary ones. In
  170.      this case select option shell/chain from the configuration menu screen
  171.      for modem  variables and set the option to chain.  Shell has advantage
  172.      over chain  because the main program  still  resides in memory.  Chain
  173.      directly loads the secondary program and must restart dndbbs from disk
  174.      after returning.  Therefore chaining is slower yet  takes less memory.
  175.  
  176.      DNDBBS Documentation                                           Page 5
  177.  
  178.      9.0 Configuration problems
  179.      --------------------------
  180.      The program does not read the configuration file:
  181.  
  182.      Delete all the configuration files (files with the extension .cfg) and
  183.      start over  with dndcnfg.  Dndcnfg loads zero  into all  configuration
  184.      values. Load the default configuration values with control-d. You will
  185.      be prompted for the node number.  Press enter for no node or enter the
  186.      node number from 0 to 9 or A to Z.
  187.  
  188.      The program does not recognize the configuration file:
  189.  
  190.      You  have not written a  new configuration file to disk. Make sure you
  191.      use the control-w command before exiting dndcnfg. Or the configuration
  192.      file is from an old version. You will prompted for the node number for
  193.      the configuration file. Press enter or type the node number.
  194.  
  195.      Installing a new version of dndbbs:
  196.  
  197.      The configuration file structure may have changed from an old version.
  198.      Delete  all  old configuration files and write  new files with dndcnfg
  199.      and the control-w command.
  200.  
  201.      The program displays errors and does not start:
  202.  
  203.      Make  sure the  statement files= in config.sys is set  for 20 or more.
  204.      Place the  statement  files=20 in config.sys and  reboot the computer.
  205.  
  206.      10.0 Setup instructions
  207.      -----------------------
  208.      The remaining contents assumes you are installing dndbbs into a fixed
  209.      disk system and your  computer is an MS-Dos compatible,  or  100% IBM
  210.      compatible.  Create a subdirectory  on your  fixed disk  and copy the
  211.      dndbbs  .zip files.  Separate the  compressed  .zip  files  with  the
  212.      PKWare  utility.
  213.  
  214.      11.0 Configuring instructions
  215.      -----------------------------
  216.      This  section is   primarily text on  creating the configure file for
  217.      dndbbs.  The dndbbs will look for this file in the  default directory
  218.      it is started from.  If the configuration file is not  found then the
  219.      program  exits with an error message to  create a configuration file.
  220.  
  221.      Start the configure program by typing  dndcnfg  in the dnd directory.
  222.      You will be presented  with a color screen  containing eight options:
  223.  
  224.      F1 Logon variables                            F5 Command variables
  225.      F2 Processing variables                       F6 Modem variables
  226.      F3 File variables                             F7 Custom equations
  227.      F4 Rooms variables                            F8 Quit configure
  228.  
  229.      DNDBBS Documentation                                           Page 6
  230.  
  231.      11.0 Configuring instructions (cont.)
  232.      -----------------------------
  233.      And a selection on the bottom line:
  234.  
  235.      Highlight Menu Choice W/ Cursor Keypad, Press Return To Select Option.
  236.      Control-D Load Default, Control-W Write Config, Control-R Read Config.
  237.  
  238.      Select the option for  loading the configuration defaults (control-d),
  239.      loading a configuration file (control-r), or writing the configuration
  240.      file (control-w).
  241.  
  242.      At this point you can select one of the eight options  with the cursor
  243.      keypad and  the enter key,  or by pressing the function key selection,
  244.      or with the first letter of  the option.  The screen will display  the
  245.      parameters for  the selected option.
  246.  
  247.      The critical operating parameters  are the datapath to the .dat (data)
  248.      files, the datapath to the .doc (documentation) files, the datapath to
  249.      the temporary work directory, and the datapath to the door information
  250.      file. They are in the file variable screen. The modem variables screen
  251.      contains  the option to operate as a rbbs door,  the door  information
  252.      file path, and communications port.
  253.  
  254.      When you have  entered  the critical options,  write the configuration
  255.      out to the dndbbs.cfg file. If you are using dndbbs as a door you must
  256.      use a node number.  The node number is used for the configuration file
  257.      name.  For node one the file created is dndbbs1.cfg,  for node two the
  258.      file created is dndbbs2.cfg, etc.  You will be  prompted for  the node
  259.      number,  or to press enter for no node number. The  configuration file
  260.      dndbbs.cfg is read by local mode (when the sysop runs the program from
  261.      dos or starts  as a standalone bbs).  When dndbbs operates  in the bbs
  262.      door mode, the program will search for the door information  file with
  263.      the specified node number.
  264.  
  265.      12.0 Operating dndbbs
  266.      ---------------------
  267.      After writing the configuration  file to disk dndbbs can start locally
  268.      with the command  dndbbs local  or  dndbbs bbs  for bbs mode. While in
  269.      bbs mode the  program  controls the modem and answers  incoming calls.
  270.      The opening screen status indicator displays the activity of the modem
  271.      during answering and connection. Dndbbs answers at speeds up to 38,400
  272.      baud. Your modem  must be 100% hayes compatible and support the entire
  273.      hayes command set. The opening screen shows the modem status, recycle,
  274.      intializaltion, reset, and off hook commands.
  275.  
  276.      DNDBBS Documentation                                           Page 7
  277.  
  278.      13.0 Modem communications
  279.      -------------------------
  280.      Sample of dndbbs to modem conversation bbs mode:
  281.  
  282.      From dndbbs to modem:
  283.      atz          (reset command, status indicator: Reset ok).
  284.      atm0e0q0v1x1 (initialization command, status indicator: Init ok).
  285.  
  286.      Now the opening screen status indicator displays Waiting for call.
  287.  
  288.      From modem to dndbbs:
  289.      ring         (for s0=0, incoming call, status indicator: Ring,
  290.                    dndbbs responds with ata, or),
  291.      connect 1200 (for s0=1, modem autoanswers, returns connect speed
  292.                    after autoanswer, 1200, 4800, 9600, 19200, or 38400).
  293.  
  294.      For 300 baud, modem returns connect then dndbbs waits and assumes 300.
  295.  
  296.      If dndbbs  does not  detected a carrier signal  within 30 seconds then
  297.      the modem  disconnects and the program recycles.  Dndbbs can configure
  298.      to disallow 300  baud access.
  299.  
  300.      14.0 Configuring for communications ports
  301.      -----------------------------------------
  302.      For sysops using multinode systems, networks or multitask applications
  303.      you may need to  configure dndbbs for  a  specific communication  port
  304.      number  besides the default of port 1. Dndcnfg modem variables  screen
  305.      allows you to set the port to any other number from 1 to 8. The fossil
  306.      device driver can access up to eight ports  on an AT.  In  order to do
  307.      this  you  must  modify  the  command   line on the  device=x00.sys in
  308.      config.sys.  Read x00  documentation for further  information. Example
  309.      of the x00 command line for 2 ports would be device=x00.sys 2.
  310.  
  311.      Example contents of config.sys:
  312.  
  313.      files=20
  314.      buffers=8
  315.      device=x00.sys 2
  316.  
  317.      15.0 Door information and nodes
  318.      -------------------------------
  319.      To start dndbbs as a door put the node number after the dndbbs command
  320.      (for example: dndbbs 1).  To specify the node  parameter  from a batch
  321.      file  use the  node number for the  first replacement  parameter  (for
  322.      example: dndbbs %1).  Select the  option in dndcnfg for the door type.
  323.      The  option for dndbbs  to be an  rbbs door should be selected.  Other
  324.      door types need to be converted to an rbbs door file with a conversion
  325.      program like DoorMaster or similar program. The door file searched for
  326.      will be dorinfox.def with x replaced with the node number.  Select the
  327.      dndcnfg option for the pathname where the dos directory containing the
  328.      door file is to be found.  Dndcnfg will add the trailing  slash at the 
  329.      end of the pathname if you forget.
  330.  
  331.      DNDBBS Documentation                                           Page 8
  332.  
  333.      16.0 Door batch files
  334.      ---------------------
  335.      Here is a  sample batch file to call dndbbs from rbbs. This batch file
  336.      is named dnd.bat  and is called from rctty.bat  from rbbs.bat with the
  337.      command dnd 1.
  338.  
  339.      cd\dnd
  340.      dndbbs %1
  341.      cd\rbbs
  342.  
  343.      For futher rbbs batch file  programming  read the  rbbs documentation.
  344.      There  are many involved batch routines for files rbbs.bat, rctty.bat,
  345.      and rbbstm.bat.  Rbbs uses the file menu5 to look  for the  keyword to
  346.      start the batch file.  The menu5 file must have the batch file name in
  347.      uppercase  surrounded  by  spaces so  rbbs can find it.  Then the rbbs
  348.      attaches  .bat to  this filename and checks the disk for the filename.
  349.      For example,  menu5  could look  like  this:
  350.  
  351.      +--------------------------------------------------------------------+
  352.      |                      Rbbs doors menu selections                    |
  353.      |                                                                    |
  354.      | Type in one of the following door options:                         |
  355.      |                                                                    |
  356.      | DND - The adventure system v2.9c-4!                                |
  357.      +--------------------------------------------------------------------+
  358.  
  359.      17.0 System environment
  360.      -----------------------
  361.      An environment  string is a  system variable locally  known to dos and
  362.      the program dos executes.  Environment strings are placed into the dos
  363.      system variable space with the set command.  Dndbbs will recognize the
  364.      strings and  use them for disk access.  There are  five  set variables
  365.      recognized by dndbbs.  You can also place the dos environment varables
  366.      into the autoexec.bat file. For example:
  367.  
  368.      set dndbbs=c:\dnd\
  369.      set dnddoc=c:\dnd\doc\
  370.      set dnddat=c:\dnd\data\
  371.      set dndtemp=d:\
  372.      set dnddoor=c:\rbbs\
  373.  
  374.      The path command can  specify the directory  containing the dndbbs.exe
  375.      program.  By combining the environment strings  with the path command,
  376.      Dndbbs can be started from any drive.  The dos environment strings are
  377.      used instead of the configuration file pathnames.  Dndbbs will add the
  378.      trailing slash at  the end of  the set  statements.  If the  directory
  379.      containing dndbbs is  c:\rbbs\dnd\ then  the path statement  would be:
  380.  
  381.      path=c:\rbbs\dnd\
  382.  
  383.      DNDBBS Documentation                                           Page 9
  384.  
  385.      18.0 Files used
  386.      ---------------
  387.      A well  organized  dndbbs  system would  make full use of the datapath
  388.      options.  The disk  drive structure  could  look something  like this:
  389.  
  390.           c:\                     c:\dnd\data\          c:\dnd\doc\
  391.           config.sys              rooms.dat             readme.1st
  392.           autoexec.bat            spells.dat            catalog.doc
  393.           ansi.sys                objects.dat           dndbbs.doc
  394.           vdisk.sys               monsters.dat          edit.doc
  395.           x00.sys                 monclass.dat          hint.doc
  396.                                   montalk.dat           summary.doc
  397.           c:\dnd\                 nonplyrs.dat          sysop.doec
  398.           brt71efr.exe            treasure.dat
  399.           dndbbsx.cfg             users.dat             c:\dnd\source\
  400.           dndbbs.exe              prelog.dat            *.bas
  401.           dndcnfg.exe             notice.dat            *.bat
  402.           dndedit.exe             welcome.dat           *.inc
  403.           dndutil.exe             logoff.dat            *.lib
  404.           edit.exe                dndedit.dat           bc.exe
  405.                                   logon.dat             link.exe
  406.           d:\ (ram disk)          help.dat
  407.           messwrk1.dat            dmhelp.dat
  408.           messwrk2.dat            messbase.dat
  409.           messwrk3.dat            *.new *.tbl
  410.  
  411.      19.0 Compiling instructions
  412.      ---------------------------
  413.      The dndbbs system is compiled  into many separate executable  files by
  414.      linking  together individual submodules.  Each submodule  has the same
  415.      include file,  dndbbs.inc,  which also  loads in several other include
  416.      files.  If  any of the .inc files are  changed then  all the  programs
  417.      must  be recompiled.  The command  line compiler distributed  with the
  418.      Microsoft Professional Development System 7.1  and  most recent linker
  419.      are  required to make  the dndbbs .exe files.
  420.  
  421.      The  bc.exe  compiler command line  switches /e, /s, and /fs are  used
  422.      when  compiling the submodules.  After each submodule is compiled then
  423.      the linker makes the .exe file.  For example:
  424.  
  425.      bc dndbbs/e/s/fs;
  426.      bc dndsub1/e/s/fs;
  427.      bc dndsub2/e/s/fs;
  428.      bc dndsub3/e/s/fs;
  429.      bc dndsub4/e/s/fs;
  430.      bc dndsub5/e/s/fs;
  431.  
  432.      link dndbbs+dndsub1+dndsub2+dndsub3+dndsub4+dndsub5,,,qbx+dtfmter/e;
  433.  
  434.      The compiler switches are:
  435.  
  436.      /e  -- local error trapping
  437.      /s  -- compress strings
  438.      /fs -- use far strings
  439.  
  440.      The linker switches are:
  441.  
  442.      /e  -- compress .exe size
  443.  
  444.      The  dndbbs source is packaged  with many  batch files to  autocompile
  445.      executable  programs.  Compile1.bat  compiles  the  dnd  main program,
  446.      compile2.bat  compiles dndedit, etc.  There  are several linking batch
  447.      files,  linkmain.bat, etc.  For example,  you could type compile4,  or
  448.      linkall,  or make,  to compile, link, or make programs.
  449.  
  450.      There  are three  library files used  by the linker to compile dndbbs.
  451.      The .lib files used are qbx.lib, dtfmter.lib, and brt71efr.lib.  These
  452.      files are  installed by  PDS 7.1 during setup.  Link the files in with
  453.      link  (brt71efr.lib links in for default)  as the  library part of the
  454.      linking command.
  455.  
  456.      DNDBBS Documentation                                           Page 10
  457.  
  458.      20.0 Rbbs door file structure information
  459.      -----------------------------------------
  460.      Rbbs v17.4 door option, 13 lines ascii text:
  461.  
  462.      dndrbbs           (bbs name)
  463.      smedley           (bbs sysop first name)
  464.      nowon             (bbs sysop last name)
  465.      com1              (comm port used, com0 for rbbs local sysop)
  466.      2400 baud,n,8,1   (baud rate and parameters)
  467.       1                (network type)
  468.      schmuckle         (sysop for local access, otherwise the user's
  469.      newbody            first name, and last name)
  470.      new york, ny.     (users city, state)
  471.       2                (graphics preference)
  472.       10               (the user level)
  473.       60               (time remaining)
  474.       -1               (fossil used)
  475.  
  476.                   ========== END OF DOCUMENTATION ==========
  477.  
  478.