home *** CD-ROM | disk | FTP | other *** search
/ Amiga Times / AmigaTimes.iso / programme / trionbbs110 / Trion / docs / 12_Doors.doc < prev    next >
Encoding:
Text File  |  1998-10-06  |  4.0 KB  |  127 lines
  1.  
  2.   Introduction
  3.   ------------
  4.  
  5.    This chapter describes what "doors" are, what types there are
  6.    and how to install doors.
  7.  
  8.   What are doors
  9.   --------------
  10.  
  11.    A door is an external program which runs on a BBS node
  12.    while a user is online.
  13.    You can look at a door as a module to extend the functionality
  14.    of the BBS program.
  15.    When a door is ran the input from a user is redirected to the
  16.    door program, and the output of the program is redirected to
  17.    the serial port.
  18.    The BBS node is suspended until the door releases control,
  19.    but the BBS node can still display messages to attention the
  20.    user that he didn't give any input for a certain time .. and
  21.    give signals to the door that the door should give control
  22.    back to the BBS if a call has to be terminated.
  23.    Also a door can request information from the BBS node.
  24.  
  25.    There a whole range of different kind of doors.
  26.    There are simple game doors that let users play all kinds
  27.    of games.
  28.    There are multi player doors, that let users log in at different
  29.    times and let them play games like chess or MUD's together.
  30.    Also there are doors that let users logged in on different nodes
  31.    play together games at the same time.
  32.    There are utility doors that extend the funtionality of the
  33.    BBS itself like Bluewave (mail) doors, CDrom doors or Top ten
  34.    user doors.
  35.    There are doors which let the user chat with the sysop or
  36.    with users on other nodes.
  37.  
  38.  
  39.   Doortypes
  40.   ---------
  41.  
  42.    There are different types of doors.
  43.  
  44.    There are the "Clidoors" .. which are basically programs that
  45.    can run in a normal shell, but with a special menu command
  46.    the input and ouput of the program is redirected to the
  47.    BBS program so the program can be used by a user on the BBS.
  48.  
  49.    There are "Arexx doors" .. which are normal arexx scripts
  50.    with special commands added that let's the BBS do all kinds
  51.    of things. There is supposedly an ABBEREXX commands set
  52.    which makes is possible to run arexx doors on different
  53.    BBS systems.
  54.  
  55.    Then there are special doors that are specific to one type
  56.    of BBS that has a special engineerd interface for that
  57.    type of door. A lot of BBS programs emulate door interfaces
  58.    so they can run doors programmed for other BBS systems.
  59.  
  60.    The Trion BBS system only supports the paragon door type
  61.    (which means it can run Paragon/Star-net/MEBBSNet doors)
  62.    and Max's BBS doors (which is a slightly change paragon
  63.    door type).
  64.  
  65.    The Trion BBS system has a specific door interface of its one,
  66.    which is basically an extension of the CliDoor concept. So if a
  67.    door does not need to use this extension it still can
  68.    run as a CliDoor on other systems. (look at the demodoor
  69.    in the docs directory).
  70.  
  71.  
  72.   Installing doors
  73.   ----------------
  74.  
  75.    To install a door you have to move the files related with
  76.    it to a directory in the doors: path.
  77.    Then you need to add a menu command to a menu to be able
  78.    to start it:
  79.  
  80.  
  81.    Clidoors
  82.  
  83.  
  84.       CliDoor         "path/door"  [, stack]
  85.  
  86.       Starts a programm like from a shell but with input and output
  87.       via the BBS node the door is started in.
  88.       Default stack space is 8192 bytes (8 KB).
  89.  
  90.  
  91.    Triondoors
  92.  
  93.       CliDoor         "path/door ~50"  [, stack]
  94.  
  95.       Trion doors are basically Clidoors, however you need to
  96.       add a ~50 at the end of the call. This puts the number
  97.       of the BBS node and the end of the command line.
  98.       A trion door needs this so it knows with which node
  99.       it should interface to exchange information.
  100.  
  101.  
  102.    RexxDoors
  103.  
  104.       RexxDoor        "path/door"  [, stack]
  105.  
  106.       This will start an Arexx script as a door from this node.
  107.       Default stack space is 8192 bytes (8 KB).
  108.  
  109.  
  110.    paragon doors
  111.  
  112.       ParagonDoor     "path/door"  [, stack]
  113.  
  114.       Start a "Paragon" Door.
  115.       Default stack space is 8192 bytes (8 KB).
  116.  
  117.  
  118.    Max's BBS Doors
  119.  
  120.       MaxDoor        "path/door"  [, stack]
  121.  
  122.       Start a "Max's BBS" door , this was implemented to be able
  123.       to use the Max's BBS CD-door.
  124.       Default stack space is 8192 bytes (8 KB).
  125.  
  126.  
  127.