home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / DOOR / AVB26.ZIP / AVB.DOC < prev    next >
Text File  |  1993-12-30  |  12KB  |  318 lines
  1.  
  2.                        ============================
  3.                            The ANSI Voting Booth
  4.                        ============================
  5.                       COPYRIGHT 1991,94 T&J Software
  6.  
  7.          One of the T&J Software Collection of multi-BBS door programs.
  8.            Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,
  9.                 UltraBBS, Telegard, TriBBS, and Remote Access.
  10.  
  11.  
  12.                         VERSION 2.60     01/01/94
  13.  
  14.                                     By
  15.  
  16.                                Tom Wildoner
  17.                              397 West Broadway
  18.                               Jim Thorpe, PA
  19.                                   18229
  20.                             VOICE (717)325-9480
  21.  
  22.                                    From
  23.  
  24.                                 The T&J BBS
  25.                                (717)325-9481
  26.                                   2 NODES
  27.                          1200/2400/9600/19200/38400
  28.                                24 Hours/Day
  29.  
  30.  
  31. LATEST VERSION:
  32. Please call the T&J BBS for the latest version of this program.
  33.  
  34. LEGALITIES:
  35.  
  36.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  37.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  38.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  39.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  40.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  41.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  42.       OR BREACH OF ANY WARRANTY.
  43.  
  44. Distribution:
  45.  
  46.    You may make this file available for downloading from your BBS or you may
  47.    upload it to any BBS of your choice, provided that you do not make any
  48.    changes to the contents of the archive (ZIP file). The archive and its
  49.    individual contents may not be used by any service that charges any money
  50.    whatsoever, without the written permission of the author.
  51.  
  52. Benefits:
  53.          -- Support for COM1-15 and non-standard port definitions
  54.          -- Online CHAT
  55.          -- Multinode support (DesqView aware)
  56.          -- Colorful ANSI screens
  57.          -- Product support BBS available
  58.          -- Sysop Functions
  59.          -- Easy SETUP!
  60.  
  61. PROGRAM DESCRIPTION:
  62. ===================
  63.  
  64. This is a fairly simple door program -- it allows you, the SysOp, to
  65. setup up to 10 different ANSI screens for your users to vote on. It's
  66. great for online competition between your users! Let your users prepare
  67. ANSI screens, upload them to you, then let the other users vote on their
  68. favorite ANSI screens! Shoot, offer a prize to the winner!
  69.  
  70. NOTE: Some ANSI screens will show better than others. The screens are first
  71. shown on the local screen and then sent to the COM PORT -- so be patient if
  72. the door seems to be hanging (odds are the user is still receiving the
  73. screen, especially for longer animation sequences).
  74.  
  75. Try saving your screens without using a clear screen command. AVB will
  76. automatically clear the screen prior to showing the ANSI screen. If
  77. you use TheDraw, simply save the file using the HOME CURSOR option as
  78. opposed to CLEAR SCREEN.
  79.  
  80.  
  81. NOTE: The voting function is disabled until registered.
  82.  
  83.  
  84. INSTALLATION:
  85. ============
  86.  
  87. Example configuration file for PCBOARD.SYS
  88. ------------------------------------------
  89.  
  90. C:\PCB\PCBOARD.SYS  <=-  (Full pathname of your PCBOARD.SYS file)
  91. T&J Software        <=-  (Change this to your BBS name)
  92. Tom                 <=-  (The Sysop's first name)
  93. Wildoner            <=-  (The Sysop's last name)
  94.  
  95. Example configuration file for USERS.SYS
  96. ----------------------------------------
  97.  
  98. C:\PCB\USERS.SYS    <=-  (Full pathname of your USERS.SYS file)
  99. T&J Software        <=-  (Change this to your BBS name)
  100. Tom                 <=-  (The Sysop's first name)
  101. Wildoner            <=-  (The Sysop's last name)
  102.  
  103. Example configuration file for DOOR.SYS
  104. ---------------------------------------
  105.  
  106. C:\BBS\DOOR.SYS     <=-  (Full pathname of your DOOR.SYS file)
  107. T&J Software        <=-  (Change this to your BBS name)
  108. Tom                 <=-  (The Sysop's first name)
  109. Wildoner            <=-  (The Sysop's last name)
  110.  
  111. Example configuration file for USERINFO.DAT
  112. -------------------------------------------
  113.  
  114. C:\BBS\USERINFO.DAT <=-  (Full pathname of your USERINFO.DAT file)
  115. T&J Software        <=-  (Change this to your BBS name)
  116. Tom                 <=-  (The Sysop's first name)
  117. Wildoner            <=-  (The Sysop's last name)
  118. NOTE: DOOR.SYS must be in the SAME directory as USERINFO.DAT
  119.  
  120. Example configuration file for CALLINFO.BBS
  121. -------------------------------------------
  122.  
  123. C:\BBS\CALLINFO.BBS <=-  (Full pathname of your CALLINFO.BBS file)
  124. T&J Software        <=-  (Change this to your BBS name)
  125. Tom                 <=-  (The Sysop's first name)
  126. Wildoner            <=-  (The Sysop's last name)
  127.  
  128. Example configuration file for DORINFOx.DEF
  129. -------------------------------------------
  130.  
  131. C:\BBS\DORINFOx.DEF <=-  (Full pathname of your DORINFOx.DEF file
  132.                           where 'x' is the BBS Node number.
  133. T&J Software        <=-  (Change this to your BBS name)
  134. Tom                 <=-  (The Sysop's first name)
  135. Wildoner            <=-  (The Sysop's last name)
  136.  
  137. Example configuration file for SFDOORS.DAT
  138. ------------------------------------------
  139.  
  140. C:\BBS\SFDOORS.DAT  <=-  (Full pathname of your SFDOORS.DAT file)
  141. T&J Software        <=-  (Change this to your BBS name)
  142. Tom                 <=-  (The Sysop's first name)
  143. Wildoner            <=-  (The Sysop's last name)
  144.  
  145. Example configuration file for GTUSER.BBS
  146. -----------------------------------------
  147.  
  148. C:\BBS\GTUSER.BBS   <=-  (Full pathname of your GTUSER.BBS file)
  149. T&J Software        <=-  (Change this to your BBS name)
  150. Tom                 <=-  (The Sysop's first name)
  151. Wildoner            <=-  (The Sysop's last name)
  152. 1                   <=-  (COM port number - defaults to 1)
  153. 1                   <=-  (Node number - defaults to 1)
  154.  
  155. Example Batch File
  156. ==================
  157.  
  158. A sample batch file is included and is similer to the following:
  159.    ECHO OFF
  160.    CD\DOORS\AVB             <=- Switch to the door's Directory.
  161.    AVB AVB.CFG              <=- Execute the door program and pass the
  162.                                 configuration filename to the program.
  163.    CD\PCB                   <=- Go back to PCB DIR when user exits door.
  164.    BOARD                    <=- Restart BBS.
  165.  
  166. This Door is multi-node  compatible so you may run more than 1 node from
  167. the same .CFG file provided the path to your system file (DORINFOx.DEF,
  168. CALLINFO.BBS, etc) is exactly the same unless you are using environment
  169. variables, (q.v.)
  170.  
  171. Environment Variables
  172. =====================
  173.  
  174. PCBoard automatically creates the %PCBDRIVE% & %PCBDIR% environment
  175. variables. Non-PCBoard systems may also use these variables by including
  176. the following in either your BBS batch or AUTOEXEC.BAT
  177.   SET PCBDRIVE=C:               <- Drive letter of your BBS files
  178.   SET PCBDIR=\BBSDIR            <- Path to your BBS files
  179. Then in your Door .CFG file instead of putting C:\BBSDIR\DOOR.SYS, you
  180. would put %PCBDRIVE%%PCBDIR%\DOOR.SYS. This allows you to use just one
  181. .CFG file for multi-node operation!
  182.  
  183. To specify a non-standard IRQ, put the IRQ number after the .CFG on the
  184. command line.  For example:
  185.  
  186.      AVB AVB.CFG /5
  187. or using the PCBDRIVE procedure:   SET IRQ=5   and use
  188.      AVB AVB.CFG /%IRQ%
  189.  
  190. This tells the program to use IRQ 5 instead of the standard IRQ.
  191.  
  192.   Had reports of conflicts when using non-standard IRQ's on Novell/Netware
  193.  systems. Seems Novell also uses the / character so something went screwy
  194.  somewhere. So I added the * (asterisk) which may be used instead of the /
  195.  in case of a conflict. In other words, /%IRQ% and *%IRQ% will both work
  196.  and are interchangeable.
  197.  
  198. When specifying the location of the system file on line 1 of the doors .CFG
  199. file, you may use the environment variables %pcbdrive%, %pcbdir%, %pcbnode%,
  200. and %wcnodeid%. Some examples:
  201.  PCBoard: 
  202.    USERS.SYS in C:\PCB           - %pcbdrive%%pcbdir%\USERS.SYS
  203.    USERS.SYS in C:\PCB\NODE1     - %pcbdrive%%pcbdir%\NODE%pcbnode%\USERS.SYS
  204.  
  205.  Wildcat!:
  206.    USERINFO.DAT in C:\WC\NODE1   - C:\WC\NODE%wcnodeid%
  207.  
  208. Non-PCBoard systems may use the PCB environment variables by setting them
  209. in either AUTOEXEC.BAT or in the batch that runs the door. For example:
  210.  SET PCBDRIVE=C:
  211.  SET PCBDIR=\BBSDIR
  212.  SET PCBNODE=1
  213.  
  214. Fossil Driver Support
  215. ---------------------
  216. DoorFrame supports the use of Fossil drivers.  To tell your Door to use the
  217. Fossil driver instead of the standard COM ports, just put /FD on the command
  218. line when running the door. For example:
  219.      MYDOOR MYDOOR.CFG /FD
  220. indicates that a Fossil driver is present and should be used. If no Fossil
  221. driver is detected, DoorFrame will print a message to that effect and exit
  222. the door gracefully.
  223.  
  224. Sysop Keys
  225. ==========
  226.  
  227. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  228.          written to DOOR.SYS and USERS.SYS
  229. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  230.          and/or written to DOOR.SYS and USERS.SYS
  231. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  232. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  233.          and/or written to DOOR.SYS and USERS.SYS
  234. F8    -  Returns the caller involuntarily to the BBS.
  235. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  236.          and/or written to DOOR.SYS and USERS.SYS
  237. F10   -  Activates SysOp CHAT mode within the DOOR.
  238. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  239. UP    -  Give the caller extra time while in the DOOR.  
  240. DN    -  Subtract time from the caller while in the DOOR. 
  241. HOME  -  HELP key for Status Line options.
  242. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  243. ALT-X -  PCBoard will exit after current caller logs off. Value is
  244.          passed to PCBoard. Not available on non-PCBoard systems.
  245.  
  246. Now, add your own screens following the format listed below. Enter all
  247. this information in the SYSOP.CFG file, see the sample one that came with
  248. the door. It would be much easier running AVB using the following
  249. command:   AVB UTILITY
  250.  
  251. This will bring up the utility program and you are offered four choices:
  252.  
  253.     1. Reset the door.
  254.     2. Make your AVB.CFG file
  255.     3. Make your SYSOP.CFG file
  256.     4. QUIT
  257.  
  258. Here is what is contained in the SYSOP.CFG file for those of you who want
  259. to use a text editor:
  260.  
  261.  
  262. 10                                     'Number of screens you have.
  263. screen1.scr                            'DOS filename for first screen.
  264. screen2.scr
  265. screen3.scr                            'All screens must reside in your
  266. screen4.scr                             AVB directory!
  267. screen5.scr
  268. screen6.scr
  269. screen7.scr
  270. screen8.scr
  271. screen9.scr
  272. screen10.scr
  273. Add for Galactic Warzone!              'Description for the first ANSI screen.
  274. Add for T&J Software Support BBS       '40 characters maximum!
  275. Bombing of IRAQ!
  276. Add for US Robotics
  277. What is it like being a SysOp?
  278. Add for Mustang Software BBS
  279. Add for Prize Vault Door game
  280. Add for Lemonade Door game
  281. T&J Software -- most popular files
  282. Eric Erway ANSI screen
  283.  
  284. NOTE: If you do not have 10 ANSI screens to show, you must include blank
  285. spaces for the rest of the entries. Lines 2-11 are the DOS filenames of the
  286. ANSI screens and lines 12-21 are the descriptions. This file must contain
  287. 21 lines.
  288.  
  289.  
  290. To run in LOCAL mode simply run:  AVB LOCAL
  291.  
  292. WHEN YOU CHANGE SCREENS:
  293. ==== === ====== =======
  294. When you switch screens (after you think all the users have had a chance
  295. to vote for the current screens), you can reset the LOG file, the voter
  296. registration file, and the vote total file by running AVB using the
  297. following command:   AVB UTILITY
  298.  
  299. Then select option 1 to reset the records.
  300.  
  301. UPGRADING:
  302.  
  303. From v2.4/2.6 to v2.6 just replace the main .EXE file and the
  304. AVB1/2/3/4.DAT files!
  305.  
  306. FUTURE VERSIONS:
  307. --->> Let me know what you would like to see!
  308.  
  309. VERSION HISTORY:
  310. See the enclosed HISTORY.TXT file.
  311.  
  312. REGISTERING:
  313. That's all there is to it! If you have any problems or questions
  314. please feel free to call the T&J BBS at (717)325-9481 and join the
  315. T&J Software Conference.
  316.  
  317. See the REGISTER.TXT file for information on registering.
  318.