home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / DOOR / TMO96DOS.ZIP / sysop.doc < prev   
Text File  |  2006-08-06  |  11KB  |  273 lines
  1. The Magic Oracle v9.6
  2. Written by Sean Dennis
  3. (C)1998-2006 Sean Dennis
  4. Another fine Cheepware production!
  5. ==========================================================================
  6.  
  7. Have questions in your life that need to be answered?  The Magic Oracle
  8. can help you decide!  The Magic Oracle is a BBS door (that can also be
  9. run locally) for any BBS that can run 16-bit DOS doors and support
  10. the DOOR.SYS and DORINFO1.DEF dropfiles.
  11.  
  12.  
  13. LICENSE
  14. =======
  15. The Magic Oracle is a freeware program, meaning you can use it for free
  16. indefintely.  However, the program and its associated files are
  17. copyrighted by Sean Dennis.  No reverse engineering, disassembling or
  18. dismantling the program is allowed.  This program is not guarenteed to
  19. do anything on your system.  If it breaks something, you own both
  20. pieces.  This program worked on my BBS before I released it.  If you'd
  21. like to port this program to another language or scripting language,
  22. contact me and we'll talk.
  23.  
  24. This program MAY NOT BE USED ON A PAY BBS!  If you charge for access
  25. and I don't mean donations, then you cannot use this door or any
  26. of my doors.  BBSing is a hobby and should be free.
  27.  
  28.  
  29.  
  30. WHAT IS THE MAGIC ORACLE?
  31. =========================
  32. The Magic Oracle ("TMO" for short) is a BBS door that is similar to
  33. the Magic 8 Ball(tm), but with more of a bite.  TMO should run on
  34. any BBS that can support 16-bit DOS doors and has a FOSSIL driver.
  35.  
  36.   Some of the features of TMO:
  37.  
  38.   * Full multinode operation (up to 255 nodes)
  39.   * Supports ALL comports and IRQs (FOSSIL driver required)
  40.   * Locked baud rates up to 115,200 BPS
  41.   * ANSI emulation built in (ANSI.SYS not needed)
  42.   * DOOR.SYS and DORINFO1.DEF support
  43.   * DesqView, OS/2, Windows and DOS timeslicing
  44.   * Customizable screens
  45.   * No configuration files - run it from the command line
  46.   * Up to 32,767 "answers" in a simple text file
  47.   * Prompts customizable
  48.   * Pipe color codes supported in text files
  49.  
  50. UPGRADING FROM A PREVIOUS VERSION
  51. =================================
  52. You no longer need ORACLE.CFG.  You should delete INDEX.DAT and run
  53. TMO locally to regenerate the INDEX.DAT file to be on the safe side.
  54. You can now use pipe or Telegard-style color codes in the data files,
  55. but not in ORACLE.ANS/.ASC.
  56.  
  57. INSTALLATION
  58. ============
  59. It's easy to install TMO.  Here's how to do it:
  60.  
  61.      1) Unzip this archive to its own directory.
  62.  
  63.      2) Set up the door in your BBS.  You can do this two ways, either by
  64.         calling the door directly (Synchronet) or using a batch file (other
  65.         BBS software).  I will show you how to set this up using a batch
  66.         file as I do in ProBoard.
  67.  
  68.         First, here's the command line parameters:
  69.  
  70.          ORACLE.EXE <full path to dropfile>
  71.  
  72.         An example:
  73.  
  74.          ORACLE.EXE D:\PB\NODE%1\DOOR.SYS
  75.  
  76.         I personally recommend using DOOR.SYS since that dropfile offers
  77.         more information than DORINFO1.DEF.
  78.  
  79.         That's all you have to use to run this door!  If you want to
  80.         run it locally, use /L on the command line.
  81.  
  82.         *** Batch file setup ***
  83.  
  84.          The batch file that I use and place in ProBoard's main directory:
  85.  
  86.            @echo off
  87.            d:
  88.            cd\doors\tmo
  89.            oracle d:\pb\node%1\door.sys
  90.            cd\pb\node%1
  91.  
  92.          I run a multiline BBS, so I pass the node number to the batch file
  93.          from the BBS.  If you use a single line, substitute the number of
  94.          your node (i.e. 1) instead of %1.
  95.  
  96.          This is the ProBoard setup (from ProCfg):
  97.  
  98.            Hotkey   : M
  99.            Function :  7 - Shell
  100.            Data     : *D*Z*Sruntmo.bat *#
  101.  
  102.          Other BBS software should be set up similar - check your BBS's
  103.          documentation on how to set the door up specifically for your
  104.          system.
  105.  
  106.       4) Run the door locally by typing ORACLE /L at the command prompt.  This
  107.          will initialize the door and will create a new INDEX.DAT (more info
  108.          on this file later).
  109.  
  110.       5) TMO should be ready for your users' and your enjoyment!
  111.  
  112.  
  113.  
  114. THE STATUS BAR
  115. ==============
  116. The status bar shown when someone is logged in and using the door looks
  117. something like this (shrunken for size in this document):
  118.  
  119. The Magic Oracle v9.6  by Sean Dennis  (C)2006 Sean Dennis
  120. Sean Dennis            Node2 OS/2 57600 Ansi  KP: 0:00 TL: 275:43
  121.  
  122.  
  123.  
  124. CUSTOMIZATION
  125. =============
  126. TMO is very customizable for your use.  You have three files you can customize:
  127.  
  128.   * ORACLE.ANS - you can create a file with .ANS or .ASC.  Please keep it small
  129.     and less than 10 lines as TMO uses absolute references on where to print
  130.     its prompts.
  131.  
  132.   * LANGUAGE.DAT - you can customize all the prompts and what characters to
  133.     use for Y and N.  Please read LANGUAGE.DAT for more information about
  134.     the prompts.
  135.  
  136.   * ANSWERS.DAT - this is the "answers" file.  Each line must be under
  137.     78 characters in length - this is NOT counting the pipe color codes, as
  138.     the codes are stripped out before display.  If the lines are longer than
  139.     78 characters, the door may behave unexpectedly.  You can have up to
  140.     32,767 "answer" lines.
  141.  
  142.     VERY IMPORTANT: If you add or subtract lines to/from ANSWERS.DAT, you
  143.     /MUST/ delete INDEX.DAT and run the door (locally is fine) to regenerate
  144.     that file!  If you do not do this, TMO will not work right!
  145.  
  146. You can use pipe color codes in the .DAT files.  They are very simple and
  147. easy to use.  These codes consist of a pipe symbol '|' followed by a
  148. number (0-23).  Here's a quick reference chart:
  149.  
  150. Code        Color
  151. ----        -----
  152.  0        Normal Black
  153.  1        Normal Blue
  154.  2        Normal Green
  155.  3        Normal Cyan
  156.  4        Normal Red
  157.  5        Normal Magenta
  158.  6        Brown
  159.  7        Normal White
  160.  8        High Intensity Black
  161.  9        High Intensity Blue
  162.  10        High Intensity Green
  163.  11        High Intensity Cyan
  164.  12        High Intensity Red
  165.  13        High Intensity Magenta
  166.  14        Yellow
  167.  15        High Intensity White
  168.  16        Background Black
  169.  17        Background Blue
  170.  18        Background Green
  171.  19        Background Cyan
  172.  20        Background Red
  173.  21        Background Magenta
  174.  22        Background Brown
  175.  23        Background White
  176.  
  177. Example: "|15|17" would set the current color to high intensity white on a
  178.      blue background.
  179.  
  180. For the Telegard-style (`xx) codes, the following applies (this was taken
  181. directly from the Telegard documentation):
  182.  
  183.         The colour sequence indicator (`), followed by two characters from
  184.         0 to 9, A to F to form the colour code.  The colour codes are
  185.         listed below for your convenience (low and high intensity side by
  186.         side).
  187.  
  188.   REGULAR
  189.            Black   Blue    Green   Cyan    Red     Magenta Brown   White
  190.           +-------+-------+-------+-------+-------+-------+-------+-------+
  191.   Black   | 00 08 | 01 09 | 02 0A | 03 0B | 04 0C | 05 0D | 06 0E | 07 0F |
  192.           +-------+-------+-------+-------+-------+-------+-------+-------+
  193.   Blue    | 10 18 | 11 19 | 12 1A | 13 1B | 14 1C | 15 1D | 16 1E | 17 1F |
  194.           +-------+-------+-------+-------+-------+-------+-------+-------+
  195.   Green   | 20 28 | 21 29 | 22 2A | 23 2B | 24 2C | 25 2D | 26 2E | 27 2F |
  196.           +-------+-------+-------+-------+-------+-------+-------+-------+
  197.   Cyan    | 30 38 | 31 39 | 32 3A | 33 3B | 34 3C | 35 3D | 36 3E | 37 3F |
  198.           +-------+-------+-------+-------+-------+-------+-------+-------+
  199.   Red     | 40 48 | 41 49 | 42 4A | 43 4B | 44 4C | 45 4D | 46 4E | 47 4F |
  200.           +-------+-------+-------+-------+-------+-------+-------+-------+
  201.   Magenta | 50 58 | 51 59 | 52 5A | 53 5B | 54 5C | 55 5D | 56 5E | 57 5F |
  202.           +-------+-------+-------+-------+-------+-------+-------+-------+
  203.   Brown   | 60 68 | 61 69 | 62 6A | 63 6B | 64 6C | 65 6D | 66 6E | 67 6F |
  204.           +-------+-------+-------+-------+-------+-------+-------+-------+
  205.   White   | 70 78 | 71 79 | 72 7A | 73 7B | 74 7C | 75 7D | 76 7E | 77 7F |
  206.           +-------+-------+-------+-------+-------+-------+-------+-------+
  207.  
  208.   BLINKING COLOURS
  209.  
  210.            Black   Blue    Green   Cyan    Red     Magenta Brown   White
  211.           +-------+-------+-------+-------+-------+-------+-------+-------+
  212.   Black   │ 80 88 | 81 89 | 82 8A | 83 8B | 84 8C | 85 8D | 86 8E | 87 8F |
  213.           +-------+-------+-------+-------+-------+-------+-------+-------+
  214.   Blue    │ 90 98 | 91 99 | 92 9A | 93 9B | 94 9C | 95 9D | 96 9E | 97 9F |
  215.           +-------+-------+-------+-------+-------+-------+-------+-------+
  216.   Green   │ A0 A8 | A1 A9 | A2 AA | A3 AB | A4 AC | A5 AD | A6 AE | A7 AF |
  217.           +-------+-------+-------+-------+-------+-------+-------+-------+
  218.   Cyan    │ B0 B8 | B1 B9 | B2 BA | B3 BB | B4 BC | B5 BD | B6 BE | B7 BF |
  219.           +-------+-------+-------+-------+-------+-------+-------+-------+
  220.   Red     │ C0 C8 | C1 C9 | C2 CA | C3 CB | C4 CC | C5 CD | C6 CE | C7 CF |
  221.           +-------+-------+-------+-------+-------+-------+-------+-------+
  222.   Magenta │ D0 D8 | D1 D9 | D2 DA | D3 DB | D4 DC | D5 DD | D6 DE | D7 DF |
  223.           +-------+-------+-------+-------+-------+-------+-------+-------+
  224.   Brown   │ E0 E8 | E1 E9 | E2 EA | E3 EB | E4 EC | E5 ED | E6 EE | E7 EF |
  225.           +-------+-------+-------+-------+-------+-------+-------+-------+
  226.   White   │ F0 F8 | F1 F9 | F2 FA | F3 FB | F4 FC | F5 FD | F6 FE | F7 FF |
  227.           +-------+-------+-------+-------+-------+-------+-------+-------+
  228.  
  229.  
  230.  
  231. CREDITS AND THANKS
  232. ==================
  233. The Magic Oracle was written in Borland Pascal 7.0 using FKFOSSIL and my
  234. custom door code.  This door contains additional code written by Larry
  235. Athey and Michael Preslar.  TMO was tested under the following BBS
  236. systems: ProBoard v2.17 (DOS) under OS/2 Warp 4.52, Telegard/2 under
  237. OS/2 Warp 4.52 and Synchronet v3.xx under Windows XP.
  238.  
  239. Special thanks to:
  240.    - Michael Preslar for helping me write this door so many years ago and
  241.      for the current support and code.
  242.    - Larry Athey for allowing me to use code from his TDK doorkit freely.
  243.    - Alan Ianson, Patrick Vittori and Kevin Nunn for beta testing.
  244.    - Sandy Chiedster of Outworld Arts for allowing me to use her art.
  245.    - My wife, Maura, for putting up with me while I write my programs.
  246.  
  247. I like to hear from people who are using my doors and even *sigh*
  248. bug reports.  You can contact me the following ways:
  249.  
  250.    - Email  : sean@outpostbbs.net
  251.    - Netmail: 1:18/200@Fidonet or 618:618/1@Micronet
  252.    - WWW    : http://outpostbbs.net
  253.    - BBS    : telnet://bbs.outpostbbs.net
  254.  
  255. I enjoy hearing from anyone who's using my doors and what they think
  256. of them.  Please feel free to drop me a line and to let me know how
  257. the doors work for you!
  258.  
  259. You can get more information about the Cheepware line by visiting
  260. http://outpostbbs.net/cheepware.html or by FREQing the magic name
  261. CHEEPWARE from bbs@outpostbbs.net (send an email with the subject
  262. of FREQ with the message of FREQ CHEEPWARE).
  263.  
  264. Cheepware, The Magic Oracle are property of Sean Dennis.
  265. FKFOSSIL is (C)1993-1994 by Tim Strike and Forbidden Knights Systems.
  266.  
  267. Thank you for using The Magic Oracle.  Support your local BBS scene!
  268.  
  269. --Sean Dennis
  270.   Cheepware Author
  271.  
  272. <EOF>
  273.