home *** CD-ROM | disk | FTP | other *** search
/ synchro.net / synchro.net.tar / synchro.net / main / BBS / NETF081.ZIP / ELEBBS.TXT next >
Encoding:
Text File  |  2002-12-02  |  11.0 KB  |  242 lines
  1. ____________________________________________________________________________
  2.  
  3.                How to install NetFoss under EleBBS/Win32:
  4.  
  5. ____________________________________________________________________________
  6.  
  7.                          Written by Mike Ehlert
  8.  
  9.   Documentation Note: I originally wrote this document as a guide for
  10.   installing another FOSSIL driver with EleBBS. At about the same time
  11.   I had started working on NetFoss, because the other one did not support
  12.   Level-5 FOSSIL functions.
  13.   This document has now been updated to use the NetFoss driver.
  14.  
  15.  
  16.  1.  First have EleBBS/Win32 up and running. <www.elebbs.com>
  17.  
  18.  2.  Copy the following files included in this archive to your
  19.      main EleBBS Directory:
  20.      NETFOSS.COM NETFOSS.DLL NF.BAT
  21.      You may also need to copy NETFOSS.DLL to a directory located
  22.      somewhere in your environment path.
  23.  
  24.  3.  Run the menu editor (ELCONFIG -M) and choose the desired language
  25.      (ie: English) and select the menu to place the door in.
  26.  
  27.      Initially you could try adding a door to your MAIN.MNU, though
  28.      if you plan to offer several door games, you could later create a
  29.      separate GAMES.MNU, and add a "goto GAMES" option in your main
  30.      menu.
  31.  
  32.      Move the cursor to the position in your menu you wish the door
  33.      to be placed, and press the <Insert> key to add a menu option,
  34.      and then press <Enter> to edit it.
  35.  
  36.      You will see these default menu options:
  37.  
  38.          Action   Display only (Type 0)
  39.          Display
  40.          OptData
  41.          HotKey
  42.          AutoExec No
  43.          Colour   Colour example
  44.  
  45.          MinSec   0                TimeUsed 0               FlatCost 0
  46.          MaxSec   0                TimeLeft 0               TimeCost 0
  47.          A flags  --------         Age      0               Terminal Any
  48.          B flags  --------         MinSpeed 0               Nodes
  49.          C flags  --------         MaxSpeed 0               Groups
  50.          D flags  --------         Credit   0               DayTimes
  51.          Lightbar
  52.  
  53.  
  54.  3a. Move the cursor to the "Action" option and press <Enter>.
  55.      Select "External - door, exits" followed by
  56.      "7 Execute sub-program".
  57.  
  58.  3b. Move the cursor to the "Display" option and press <Enter>.
  59.      Type in what you want to be displayed on your users menu.
  60.      You can press F1 to change colors, F2 to sample how it
  61.      looks so far, or F3 to add a macro. Press <Enter> when
  62.      you are done.
  63.      ** Important ** : If you use ANSI screens to display menus
  64.      rather then having EleBBS create the menu screens itself,
  65.      (done using a type-40 command in your menu) then just put
  66.      a semicolon ";" on the Display line and press <Enter>.
  67.      This will prevent a carriage return from being displayed.
  68.  
  69.  3c. Move the cursor to the "OptData" option and press <Enter>.
  70.      This is where the command line goes that runs the door,
  71.      or runs a batch file which will run the door.
  72.      Enter the following:
  73.  
  74.      <path\nf.bat> <path\filename of door> <any optional parameters>
  75.  
  76.      Many doors require a batch file, often needed to change to the
  77.      doors directory before executing the door itself. You can replace
  78.      the <path\filename of door> with <path\filename of batch file>.
  79.      Note that the "*C /c" macro used by Win9x and DOS to allow running
  80.      a batch file, is never needed under Windows NT, 2000, or XP.
  81.  
  82.      Assuming that EleBBS is located in c:\ele, the Optdata command
  83.      line should look something like this:
  84.  
  85.      c:\ele\nf.bat c:\ele\doors\doorgame.bat *N
  86.  
  87.      The optional *N macro passes the node number to the doorgame.bat
  88.      file, which can be referenced as %1 (the first parameter passed)
  89.      in the batch file itself.
  90.  
  91.  3d. Move the cursor to the "HotKey" option and press <Enter>.
  92.      Now press the key that you would like to cause this door to be
  93.      run, followed by <Enter>. Usually either a letter from A-Z or a
  94.      number 0-9, though other characters could be used as well.
  95.      Note that if you assign the same hotkey to more then one menu
  96.      option in a menu, then only the first option which qualifies
  97.      will be executed.
  98.  
  99.  3e. If you want to specify security levels or flag settings required
  100.      to access this door, you can define those in the MinSec, MaxSec,
  101.      and the A,B,C,D flags. Otherwise just skip over to the next step.
  102.  
  103.  3f. If your menu uses Lightbars, you will need to edit the lightbar
  104.      text and position for the Display text. Otherwise just skip to
  105.      the next step. To define a lightbar, move the cursor to the
  106.      "Lightbar" option and press <Enter>. Next select the "Position"
  107.      option, and enter the X and Y coordinates where the lightbar
  108.      should appear on the users screen (X=horizontal, Y=vertical).
  109.      Next select the "LowItem" option, and enter the Display text
  110.      shown in the color(s) when the lightbar is not active.
  111.      Press F1 to change colors, F2 to see a sample of the lightbar,
  112.      F3 to add a macro, and <Enter> when done.  Next do the same
  113.      for the "HighItem" option, which should be set to the colors
  114.      when the lightbar is active. Finally set the "Enabled" to "yes".
  115.      Press ESC to return to the menu editor.
  116.  
  117.  3g. If you want to set other limitations on who can access this
  118.      menu option, then set the other menu options accordingly.
  119.      (ie: TimeLeft, Age, Credit, Terminal type, Nodes, Groups, etc.)
  120.      Otherwise just leave these options at their defaults.
  121.  
  122.  3f. Once you are done editing your menu options, press ESC to return
  123.      to the Menu Editor, and answer "Yes" to save changes. You can
  124.      press ESC again to exit the menu editor.
  125.  
  126.  
  127.   4. Next you need to configure your door.
  128.      To perform this step, you will need to read the documentation
  129.      that came with your door.
  130.      Most doors include a configuration program, but many doors
  131.      use text based config files that you need to configure with
  132.      a text editor. There is often a separate config file needed
  133.      for each node, though this is not always the case.
  134.  
  135.      Most DOS doors support a FOSSIL driver. Using a FOSSIL driver
  136.      is optional on some DOS doors, in which case it must be
  137.      configured to use a FOSSIL driver rather then direct
  138.      communication with a COM port.
  139.      
  140.      Dropfiles are used by most doors, to get information from the
  141.      BBS such as: The users name or handle, the amount of time they
  142.      are allowed to use in the door, their terminal settings, their
  143.      com port number, and their connection speed.
  144.  
  145.      Most doors allow you to select a dropfile type, such as DOOR.SYS
  146.      or DORINFO1.DEF. I suggest you always choose DOOR.SYS, as this
  147.      is the most common dropfile. You can also use DORINFO1.DEF, but
  148.      some doors assume that its called DORINFOx.DEF, where x= the node
  149.      number. Since EleBBS (and most BBS's) create only a DORINFO1.DEF
  150.      for each node, this could be a problem.
  151.  
  152.      The most advanced dropfile type is EXITINFO.BBS, which contains
  153.      detailed information about the user. This is only supported by
  154.      doors designed specifically for EleBBS, RA, or ProBoard. One
  155.      advantage to this drop file, is the door is allowed to make
  156.      changes to this dropfile, which is read back by EleBBS after
  157.      the door exits. This makes it useful for doors that need to
  158.      alter the users settings, such as timebanks and mail doors.
  159.  
  160.      Some doors are smart enough to look for the dropfiles in the
  161.      current directory, and automatically look for the doors data files
  162.      in the directory where the door itself is located. Unfortunately
  163.      most doors do NOT work this way, and need to be told the full
  164.      path to the dropfile for each node.
  165.  
  166.      EleBBS always creates all dropfiles in the current directory
  167.      where it was started, known as a node directory. For example:
  168.  
  169.      c:\ele        main elebbs directory, where elebbs.exe is.
  170.      c:\ele\node1  where node #1 is started.
  171.      c:\ele\node2  where node #2 is started.
  172.      c:\ele\node2  where node #3 is started.
  173.  
  174.      If EleBBS.EXE is started from a batch file, then the batch file
  175.      itself is responsible for changing to the proper node directory
  176.      before running EleBBS.EXE from the main directory.
  177.      If EleBBS.EXE is started by TelSrv.EXE (The Telnet Server),
  178.      then the node directories must be defined in ELCONFIG.EXE
  179.      under PATHS SYSTEM > PATHS > NODE PATHS
  180.      (ie: c:\ele\node*N would be used, as *N is replaced with the
  181.      actual node number).
  182.  
  183.      Since most doors look for their data files in the current
  184.      directory, you will usually need to run a batch file that
  185.      changes to the doors directory before running the door's EXE.
  186.      The batch file does not need to change back to the node directory
  187.      afterwards, as this is automatically done by EleBBS itself.
  188.  
  189.      An example batch file could look like this:
  190.  
  191.      cd\ele\lord
  192.      lord.exe %1 /drew
  193.  
  194.  
  195.      In this example, the batch file changes to the \ele\lord
  196.      directory, and then runs lord.exe, passing it two parameters.
  197.      The %1 parameter is used to pass the node number (assuming that
  198.      *N was the first optional parameter passed to the batch file
  199.      on the menus type-7 Optdata command line), and in this case
  200.      the door wants an additional parameter "/drew" in order to
  201.      function.
  202.  
  203.      Other doors often need to be passed the name of a config file
  204.      on the command line, such as this example:
  205.  
  206.      cd\ele\ea
  207.      ea.exe ea%1.cfg
  208.  
  209.      And then you would need to edit a separate config file for each
  210.      node you wish to support, such as ea1.cfg, ea2.cfg, and so on.
  211.      These config files usually include a full path and filename to the
  212.      dropfile which should be used, in addition to other information.
  213.  
  214.      Another popular method used by some doors, is to pass the
  215.      path and/or the dropfile name on the command line, like so:
  216.  
  217.      cd\ele\gifsee
  218.      set gifdesk=file
  219.      gifsee.exe c:\ele\node%1\exitinfo.bbs
  220.  
  221.  
  222.      Again, you will need to consult the documentation that came
  223.      with your door to know exactly how your batch file or command
  224.      line should look, as not all doors do it the same way.
  225.  
  226.      NetFoss ignores the "FOSSIL com port" it is told to use, so it
  227.      really makes no differnce if the door is attempting to talk to
  228.      COM1 or COM2. However, many door games were written before there
  229.      was telnet support, or were written with older door libraries
  230.      which often only support COM1 through COM9, and some doors only
  231.      support up to COM4.
  232.      Therefore NetFoss allows the door to specify any FOSSIL comport,
  233.      and it will work even if all the nodes are set to use COM1 for
  234.      example. When running EleBBS's TelSrv.EXE, EleBBS.EXE is not
  235.      passed a comport number on the command line, so it will allways
  236.      pass the COM port number specified in MODEM.RA to the dropfiles
  237.      it creates. As long as the comport defined in MODEM.RA
  238.      (found in ELCONFIG > MODEM > OPTIONS > COMPORT) is less then 5,
  239.      most doors will work on all 255 nodes! :)
  240.  
  241.  
  242.