home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / HANOI10.ZIP / HANOI10.DOC < prev    next >
Text File  |  1995-06-15  |  24KB  |  486 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                                             TOWERS OF HANOI |
  7.                                                                             |
  8.                                                                 version 1.0 |
  9.                                                                             |
  10.                                                                             |
  11.                                      A multi-node door for most BBS systems |
  12.                                       Copyright 1995 by DIRT CHEAP SOFTWARE |
  13.                                                Written in C by Bruce Bowman |
  14.                                                                             |
  15.                                                      Released June 20, 1995 |
  16.                                                                             |
  17.                                INTRODUCTION
  18.                                ============                                                                          
  19.  
  20.  >Disclaimer<  Throughout this document, I have used the masculine gender
  21.  when referring to a "generic" person.   This is only to avoid continuous
  22.  use of such things as (s)he, which I find annoying. I have total respect
  23.  for the females of the species; I even married one. So lighten up.   :^)
  24.  
  25.  >Disclaimer #2<  The author of this program, Bruce Bowman, promises only
  26.  that this program will take up space on your hard drive (and perhaps not
  27.  even that). I've put a lot of my time and sweat equity into this, and in
  28.  return I ask only that you  try it and remit a token sum if you continue
  29.  to do so. I make no claims for its suitability for a particular purpose,
  30.  and guarantee nothing  whatsoever regarding potential damage to your own
  31.  computer or hard-acquired files.  I can only suggest that you  do what I
  32.  do, and back up  your hard drive frequently.  If the unthinkable happens
  33.  and some terrible fate should befall you  as a direct or indirect result
  34.  of using Towers of Hanoi, you will have my utmost sympathy -- but that's
  35.  about all. So there.   :^)                                                    
  36.  
  37.  This software is COPYRIGHTED: You're subject to the associated penalties
  38.  of law if you attempt to reverse-engineer it, hack the key routines,  or
  39.  otherwise steal the benefits of all my aforementioned sweat equity.     
  40.                                                                          
  41.                                QUICK START                               
  42.                                ===========                               
  43.                                                                          
  44. See the file QUICK_ST.ART for fast instructions on how to test and set up  
  45. Towers of Hanoi.                                                           
  46.                                                                          
  47.                                  OVERVIEW                               
  48.                                  ========                                 
  49.                                                                          
  50. Towers of Hanoi is based on an old oriental puzzle. The object of the game
  51. is to move a stack of disks of different sizes from one post to another, 
  52. one at a time, without ever putting a larger disk on top of a smaller one.
  53. It sounds simple, but the task is a lot harder than you might think! To do 
  54. well, you will need a quick analytical mind and some manual dexterity. 
  55. Additional disks increase the difficulty significantly. The door includes 
  56. an online Hall of Fame to store the best times!
  57.  
  58. At only $8 registration, this door is a bargain.
  59.  
  60. Towers of Hanoi offers the following sysop features (and more I've probably
  61. overlooked in these docs):
  62.  
  63. -  As you would expect, Towers of Hanoi monitors carrier detect functions, to
  64.    automatically recover when a user drops carrier.                    
  65.                                                                        
  66. -  Includes a fully-adjustable inactivity timeout monitor. A warning is
  67.    sent 5 seconds before the caller is ejected.
  68.  
  69. -  Share-aware file i/o for use in multi-node BBS systems. You must have 
  70.    DOS's SHARE.EXE loaded for multi-node use.             
  71.  
  72. -  Supports most popular BBS door information files, such as DORINFO1.DEF,
  73.    EXITINFO.BBS, CHAIN.TXT, DOOR.SYS, etc.  
  74.  
  75. -  Integrated chat, simple configuration, "multiple personality" system, 
  76.    session logging, paging hours, Hall of Fame, supports CUSTOM DROP FILE 
  77.    FORMATS, and MORE!
  78.  
  79. -  Displays and updates a QuickBBS-style status line, with information 
  80.    available to the sysop such as user name, location, baud rate, time left, 
  81.    function keys, ANSI and AVATAR settings, and so on.
  82.    
  83. -  Keeps track of a user "wants-chat" indicator, just like the one in
  84.    RemoteAccess, QuickBBS and other BBS systems. Allows for sysop page from
  85.    the door, and integrated chat mode.
  86.  
  87. -  Provides the sysop with all the standard function keys for adjusting user 
  88.    time, hanging up on or even locking out the user -- and sysop shell to DOS.
  89.  
  90. -  Full support for locked baud-rates of up to 115200 baud, using the FOSSIL
  91.    driver for maximum compatibility with any system. If a FOSSIL is not
  92.    available, Towers of Hanoi will use its own communications routines. 
  93.    Auto-detect of local operation.
  94.  
  95. -  Towers of Hanoi is also DesqView and Windows aware. It will automatically 
  96.    check for the presence of a multitasker, and if available, will perform 
  97.    all of its screen output through the appropriate function calls and
  98.    release time slices to other tasks.
  99.  
  100.       
  101.                           COMMAND LINE PARAMETERS
  102.                           =======================
  103.  
  104. Most configuration is done via the configuration file. See the HANOI1.CFG
  105. file for an example and instructions on how to edit the paths and other
  106. parameters for your own use. If running multi-node, you'll normally need to
  107. create a separate config file for each node running the door.
  108.  
  109. Call the program with the following syntax: 
  110.  
  111. HANOI <cfgfile>  
  112.            
  113. Where:
  114.  
  115. <cfgfile> REQUIRED: Name of the config file. Include the path, if necessary.
  116.           The config file used will normally vary depending on the node 
  117.           using the door. I usually set things up so the node number is 
  118.           passed on the menu item command line, something like this:
  119.           
  120.                 C:\BBS\DOORS\HANOI.EXE C:\BBS\DOORS\HANOI*N.CFG
  121.           
  122.           The *N parameter is a 'metacharacter' that the BBS software uses
  123.           to provide the node number to the door. This allows you to set up
  124.           a single menu item that will run the program for all nodes without
  125.           resorting to batch files.
  126.  
  127.          
  128. Examples:
  129. --------
  130.  
  131.    HANOI HANOI1.CFG
  132.    
  133.          Bring up the door with the node 1 config file. Note that this command
  134.          assumes that you have already changed to the directory containing the
  135.          executable and config files; so it's probably only suitable for use 
  136.          in a batch file for node 1. 
  137.          
  138.    C:\BBS\DOORS\HANOI.EXE C:\BBS\DOORS\HANOI*N.CFG
  139.    
  140.          Run the door from node 2. This example uses the BBS metacharacter to
  141.          select the appropriate config file for each node automatically. This
  142.          command can therefore be placed directly into the BBS menu item. Once
  143.          edited with your own directory paths, the example above should work 
  144.          for QuickBBS, RemoteAccess, and clones. Note that some BBS software
  145.          will not allow you to omit the .EXE extension.
  146.                  
  147.    C:\BBS\DOORS\HANOI 
  148.    
  149.          ERROR. Config file name is REQUIRED.
  150.     
  151.  
  152. What could be simpler?                                   
  153.                       
  154.  
  155.                          OTHER COMMAND-LINE OPTIONS 
  156.                          ==========================
  157.                          
  158. You MUST be in the Towers of Hanoi directory to use this option!
  159.  
  160.  
  161.    HANOI LOCAL            (Local mode)
  162.    
  163.          Runs Towers of Hanoi with sysop defaults. This mode does not require
  164.          a configuration file or any door information (drop) files. It's
  165.          mainly used to play with the door a little to see if you like it
  166.          prior to setting it up.
  167.  
  168.          
  169.                       CARE AND FEEDING OF TOWERS OF HANOI
  170.                       ===================================
  171.  
  172. There isn't any. The Towers of Hanoi takes care of itself. The game will 
  173. create files called HANOI.BBS and HANOI.HOF to store data it needs. To reset
  174. the Hall of Fame, just delete the HANOI.HOF file.                      
  175.                   
  176.  
  177.                               SYSOP FUNCTIONS
  178.                               ===============
  179.                               
  180. Status Line - By default, the status line is ON. To turn it off, press F10.
  181. The status line lists the name of the user currently on-line, his location, 
  182. and baud rate (0 if the door is operating in local mode). You may also find
  183. out how much time the user has left, check for indicators as to whether the 
  184. user has ANSI and/or AVATAR modes on, etc.  If the user wishes to Chat with 
  185. the sysop (ie: they have paged the sysop, but haven't received a response), 
  186. a [Want-Chat] indicator will flash on the status line. 
  187.  
  188. The appearance of the status line varies with the "personality" setting 
  189. chosen in the config file. The following is for the "Remote Access" style, 
  190. but the other styles are similar.
  191.  
  192. [F1]..[F10] - The Function keys [F1] thru [F10] allows the sysop access to 
  193.               various types of information on the status line, or to turn 
  194.               the status line off. These keys are as follows:
  195.  
  196.               [F1] -  Display basic door and user information
  197.               [F2] -  Display phone numbers and important dates
  198.               [F3] -  Display security flags and up/download info
  199.               [F4] -  Display system information and current time
  200.               [F5] -  Display message info and user's settings
  201.               [F6] -  Display chat reason and sysop's comment
  202.               [F9] -  Display help information for sysop
  203.               [F10] - Toggle the status line on/off                               
  204.               
  205. The following other function keys are also available to the sysop:
  206.  
  207. [UP]/[DOWN] - Use the arrow keys to increase or decrease the amount of 
  208.               time the caller has left in the door.
  209.  
  210. [Alt]-[C] -   Allows the sysop to break into chat with the caller at any 
  211.               time. [Alt]-[C] again, or [ESC] will end chat mode. (Notice 
  212.               that the Want-Chat indicator will also be turned off, if it 
  213.               was flashing). If your door is running under Apex, Remote
  214.               Access or QuickBBS, paging from within the door will also
  215.               cause the Want-Chat indicator to stay lit when the user 
  216.               returns to the BBS.
  217.  
  218. [Alt]-[J] -   Allows the sysop to shell to DOS, if enough memory is 
  219.               available. Simply type EXIT to return to the door.
  220.  
  221. [Alt]-[H] -   Hang up on the user. Drops carrier and returns to the BBS.
  222.  
  223. [Alt]-[L] -   This key locks the user out of the BBS. It first hangs up 
  224.               on the user, and then sets their security level to 0, to 
  225.               prevent them from ever logging on again. This feature may 
  226.               require use of the EXITINFO.BBS file, depending on what 
  227.               system the door is running under.
  228.  
  229. [Alt]-[K] -   The "User Keyboard-Off" key allows the sysop to temporarily 
  230.               prevent the user from typing anything on their keyboard. 
  231.               This has no effect on the local keyboard, but causes the
  232.               door to ignore any keystrokes from remote. 
  233.  
  234. [Alt]-[N] -   The "Sysop Next" key, this function reserves the system for 
  235.               use by the sysop after the user logs off, if the door is 
  236.               running under an Apex or RA 1.00 or later system.
  237.  
  238. [Alt]-[D] -   "Drop to BBS" key. This function allows the sysop to exit 
  239.               the door and return the user to the BBS, without hanging up.
  240.  
  241.                                                       
  242.                                USING THE DOOR
  243.                                ==============
  244.                                
  245. The door is menu-driven, and most of the functions are self-explanatory. A 
  246. brief overview will be given here.
  247.  
  248. Towers of Hanoi is an ancient puzzle that is sometimes used in computer 
  249. programming texts as a tool for teaching recursive logic. The game consists
  250. of three posts, and a number of disks of increasing size. These disks are
  251. placed on one of the posts, pyramid-fashion, with the smallest disk at the
  252. top. The computer will select a destination post. The object of the game is
  253. to move all the disks to this post in the same configuration, without ever
  254. placing a large disk on a smaller disk.
  255.  
  256. Just playing the game a few times is the best way to get an idea of what is
  257. going on. Also, be sure to avail yourself of the online help!
  258.     
  259. The opening screen allows the caller to perform most game operations. To 
  260. select an option, type the key in angle brackets.
  261.  
  262. <Q>uit Door -- Ends the door session and returns to the BBS. You may
  263.    select this option at any time, even during a game.
  264.    
  265. <L>og Off -- Ends the door session and also hangs up the modem. In order
  266.    for this option to work, you may need to be using certain types of
  267.    BBS software; not all BBS system support a remote logoff.
  268.    
  269. <P>age Sysop -- Sounds a tone at the local console. The sysop can break
  270.    into chat at any time by typing Alt-C. This function allows the
  271.    caller to request a chat session, if not outside of paging hours.
  272.    
  273. <G>ame Rules -- A brief, 1-screen overview of the rules of the game.
  274.  
  275. <D>oor Hints -- Another 1-screen overview of what the commands do and
  276.    a hint on how to approach the puzzle.
  277.         
  278. <#> of Disks -- Changes the number of disks to be used in your next game.
  279.    You cannot change this during a game. Adding one disk requires twice
  280.    as many moves to complete the puzzle!
  281.  
  282. <S>tart a Game -- Sets up a new game using the "current" number of disks.
  283.    The timer doesn't start, however, until you begin your first move. To
  284.    move, just type a post number, and the top disk will be highlighted.
  285.    Then type the destination post for that disk, and the disk will be 
  286.    moved.
  287.    
  288. <R>edraw Screen -- This command is active at all time, just in case line
  289.    noise messes up the remote screen.
  290.    
  291. <H>all of Fame -- Displays the Hall of Fame for this level, sorted by
  292.    time. The less time you take to complete the puzzle, the higher you'll 
  293.    end up in the Hall of Fame! Each number of disks has a separate Hall of
  294.    Fame.
  295.      
  296.                               REGISTRATION
  297.                               ============
  298.                               
  299. To Other Shareware Authors:
  300.  
  301. I will happily exchange registrations to any of my products, if what you 
  302. have interests me at all.  Netmail me with the specifics if interested.
  303.  
  304. (Not responsible for lost or misrouted mail!).
  305.  
  306. The key consists of a small file that resides in the same directory as
  307. your game file (HANOI.BBS). Ordinarily, I would find this abhorrent -- 
  308. but I'm just too stupid to figure out a way to patch the executable with 
  309. a key entered in a config program (which would also require a config 
  310. program!).
  311.  
  312. Benefits of Registration
  313. ------------------------
  314. 1) The door will not allow configuration of Maximum games/day or Maximum
  315.    disks. For example, to play with more than 6 disks, you'll have to 
  316.    register.
  317.  
  318. 2) You cannot disable paging or set paging hours unless registered.
  319.  
  320. 3) The door will display a registration delay when opened until registered.
  321.  
  322. 4) The door will display -= UNREGISTERED =- when returning to the BBS
  323.    until you register.
  324.  
  325. 5) You will receive preferential support from the author.
  326.  
  327. 6) You will have peace of mind, knowing that you are supporting shareware.
  328.  
  329. How do you register?  Send $8 (US) cash, check or money order, payable to
  330. Bruce Bowman, to the following address:
  331.  
  332.                        DIRT CHEAP SOFTWARE
  333.                        c/o Bruce Bowman
  334.                        8364 S. State Road 39
  335.                        Clayton, IN  46118
  336.  
  337. Allow 2 weeks for personal checks to clear. I'm told it's not a good idea 
  338. to send cash via the mail, but I've never had problems with it. If you 
  339. decide to do so, and the money gets ripped off, I will feel sorry for you 
  340. but I won't waive your registration fee over it.
  341.  
  342. Accompany this with the form on the following page...or otherwise provide 
  343. this information.  Registrations without this information WILL be ignored
  344. (I will make a feeble attempt to contact you, and eventually tear up your
  345. check).
  346.  
  347. On occasion I have attempted to netmail certain individuals keys, only to 
  348. get bad connects -- I simply cannot afford this. If your BBS is only online
  349. during certain hours, let me know. If I get two bad connects trying to 
  350. netmail a key, I will give up and put it on hold for you and notify you of 
  351. this fact via routed netmail (which itself is not very reliable anymore).
  352.  
  353. NOTE:
  354. Registered keyholders receive FREE UPGRADES when they become available.
  355. You will have to check in though, since I don't plan to notify everyone of
  356. an upgrade individually.
  357.  
  358.                         TOWERS OF HANOI REGISTRATION 
  359.                                Version 1.0
  360.                               
  361. IMPORTANT!  The BBS name and SYSOP name must match your door   IMPORTANT!
  362. IMPORTANT! drop file EXACTLY, or your key won't work. Consider IMPORTANT! 
  363. IMPORTANT!     sending us a copy of your BBS drop file(s)!     IMPORTANT!                    
  364.  
  365. *SYSOP NAME: __________________________________________________________
  366.  
  367. ADDRESS: ______________________________________________________________
  368.  
  369. _______________________________________________________________________
  370.  
  371. _______________________________________________________________________
  372.  
  373. *BBS NAME: ____________________________________________________________
  374.  
  375. BBS Phone: ____________________________________________________________
  376.  
  377. BBS Software/Version: _________________________________________________
  378.  
  379. NETWORK: _______________________________________ (FidoNet, etc, if any)
  380.  
  381. NETWORK NODE NUMBER: _______ : ________ / ________ (if above completed)
  382.  
  383. AMOUNT ENCLOSED: ______________________       NOTE: Registration is $8!
  384.                                                                     
  385. HOW DO YOU WANT TO PICK UP THE KEY?
  386.  
  387. [ ] ... Put on hold for me at 1:231/710 for the Net/Node listed above.
  388.  
  389. [ ] ... Send via FidoNet crashmail to the node indicated above.
  390.  
  391. [ ] ... Here's $2.00 Upload it to me as well as the latest version.  
  392.         Acount Information as Follows:
  393.  
  394.         Account Name:  Bruce Bowman
  395.         
  396.         Password: ____________________________________
  397.         
  398.         Miscellaneous Info: ________________________________________
  399.  
  400.         ____________________________________________________________
  401.  
  402. [ ] ... Send on disk to the address above (very slow!) Please add $5 to 
  403.         cover disk, mailing costs, and my hassle.  
  404.         Please ship my key and latest copy via  [ ] - 5.25"   [ ] - 3.5"
  405.                                                                     
  406. [ ] ... YES!! I WANT THE SPECIAL DEAL! Send me latest version of KaBoom!
  407.         and its key for only $7 more!!
  408.  
  409. COMMENTS/SUGGESTIONS/BUGS: ____________________________________________
  410.  
  411. _______________________________________________________________________
  412.  
  413. __________________________________________________________________@o.tw  
  414.                             TECHNICAL SUPPORT
  415.                             ----------------- 
  416.  
  417. TECHNICAL SUPPORT IS PROVIDED ONLY THROUGH EMAIL OR CALLING MY BBS! 
  418.  
  419. I have had people ask me to call them long-distance on my dime -- I simply 
  420. don't make enough money on Towers of Hanoi to justify this. There seems to 
  421. be a perception amongst the sysop community that door authors are getting 
  422. rich selling their doors, but the truth is that most sysops never register 
  423. their doors. 
  424.  
  425. To obtain support, you must call my BBS or send me email. You will be
  426. given a full-access, temporary account on your first call...so you can
  427. leave me a message or download other DIRT CHEAP programs. You'll have to 
  428. call the BBS again to get your reply; or if you're on FidoNet and can 
  429. wait, I can send you routed netmail. InterNet email is quicker.
  430.  
  431.                    The H.O.M.E. BBS
  432.                    (317) 539-6579 - 28.8 kbps
  433.                    FIDONET:  1:231/710
  434.                    DOORNET:  75:7317/71
  435.                    INTERNET: beb@lilly.com or
  436.                              Bruce_Bowman@f710.n231.z1.fidonet.org
  437.  
  438.  
  439.                              FREQUENT COMMENTS
  440.                              =================
  441.  
  442. Q: The door can't find the game files, or it can't find my key even though 
  443.    I've registered. Help!
  444. A: Run the door from the directory containing the game file and the key,
  445.    or place the correct path in the config file under "DoorDir." The 
  446.    executable can be anywhere on your path. Make sure Towers of Hanoi knows 
  447.    where your drop files are from the "BBSDir" parameter. If your key is 
  448.    named something else, be sure to rename it to HANOI.KEY. Finally,
  449.    try putting your system name and sysop name in the configuration file.
  450.    
  451.    If it still does not recognize your key, you either did not provide 
  452.    the correct BBS and sysop names on your registration form, or your
  453.    system is misconfigured so this information is not appearing in your
  454.    drop files. Upload a copy of your drop files to the support BBS or via
  455.    email to one of the listed addresses.
  456.    
  457. Q: When I call the door, the status line quickly flashes on and comes back
  458.    to the DOS prompt.
  459. A: You are probably giving Towers of Hanoi a nonexistent config file name. 
  460.    Make sure you use the correct metacharacter in your menu, and that you 
  461.    haven't misspelled anything.
  462.  
  463. Q: The game prints [2;4m brackets and other junk characters all over.
  464. A: The door requires ANSI, AVATAR or RIP graphics capability. Exit the door
  465.    and rectify the situation.
  466.   
  467. Q: The file HANOI.BBS or HANOI.HOF exists, but I occasionally still get 
  468.    a message from the door saying "Error opening HANOI.BBS/HANOI.HOF!"
  469. A: The door will try 20 times to open the file over a 10-second interval. If 
  470.    this fails, Towers of Hanoi gives up with an error.    
  471.    You may be running out of file handles. Increase the number of FILES in 
  472.    your CONFIG.SYS. 
  473.    It is also possible that one task in a multi-tasking environment opened
  474.    the file, and then crashed without closing it. If so, you will probably
  475.    have to reboot to clear the error.
  476.    This may also rarely happen during intensive disk activity in a multi-
  477.    tasking environment (for example, when copying files to/from floppies). 
  478.    Use a copy utility (like DVCOPY) that will properly release time slices 
  479.    to your door.
  480.    You *do* have DOS's SHARE.EXE loaded, don't you?
  481.  
  482.  
  483.                                 PRODUCT HISTORY
  484.                                 ---------------
  485.                     
  486. 6/95   Initial release of Towers of Hanoi.