Beijing Paradise BBS Backup

home *** CD-ROM | disk | FTP | other *** search

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / BBSLOG.ARJ / NOTSUPP.DOC < prev next >

Wrap

Text File | 1994-03-08 | 27.7 KB | 678 lines

Introduction This document is a basic installation guide to doors written with the BBS Onliner Interface. A basic synopsis of the command line arguments is given Sections Command Line Directives Again Play /A Player Name /N Quiet Local Console /Q Limit Hall Of Fame /X Redirect Hall Of Fame /Y Maximum Time Limit /Z Communications Directives Locked Com Port /B Specific BBS Installation Examples and Notes Generic Installation Batch File Example Generic Installation Command Line Example 2 A.M. Auntie DoorWay to Unlimited Doors EIS-PC Force FoReM Forum GAP Genesis GT Maximus ModuleX OLEcom Opus 1.13 Opus 1.14 PCBoard 12.x PCBoard 14.x Phoenix ProBoard QuickBBS RBBS (batch /R) Remote Access RyBBS Sapphire Searchlight Command Line Example (/9) Simplex Spitfire TAG Telegard TPBoard Virtual (batch /4, /S, or /Rn) WildCat! WWIV (batch /4) Other Notes DESQview Windows OS/2 and other multitaskers File Sharing/Locking What Went Wrong??? (or "Jane, how do I turn this thing off?") Error messages BBS Onliner Interface - Command Line Directives Be sure to check out the door specific documentation about any other command line directives that may be available. Again Play (/A:x) This option will allow players to play multiple games at one sitting as long as they have as muchtime. If they have more "x" minutes left (/a:x). This option carries no recommendation. Player Name (/N:User_Name) This switch is usually only necessary if the user information is passed via command line instead of through a drop file (ie: Searchlight BBS). It can also be used for at home play with a batch file to make things simple. Quiet Local Console (/Q) This will keep the bell from beeping on the host computer. This lets the SysOp to spleep at night, and it is highly recommended. Limit Hall Of Fame (/X:n) This options the player to a maximum of "n" appearences in the Hall of Fame. I recommend /x:2 as this keeps one or two rabid players from monopolizing the Hall of Fame. Redirect Hall Of Fame (/Y:<path/filespec> I heartily recommend using the text Hall of Fames as online bulletins. The BBSs around here that use the bulletins tend to have 5 to 10 times the play as the BBSs that don't. This option is fully explained in COMMANDS.BOI. Maximum Time Limit (/Z:x) The BOI normally limits users to the amount of time specified in the drop file. This option allows SysOps to set a maximum upper limit. The game will execute an inactivity time-out at approximately two minutes. It will beep at the halfway point and then again when it returns control to the BBS. Communications Directives (/C /I /K /L F) Communications directives are beyond the scope of this document. They are fully explained in COMMANDS.BOI. Locked Com Ports (/B) The BOI (when not using FOSSIL), uses RTS (UART Ready To Send) handshaking. When you lock the DTE-DTC rate (your computer to your modem) higher than the possible connect rate between your modem and the remote (DTC-DTC rate), RTS handshaking is insufficient, and may result in modem buffer overruns and loss of data. Adding this switch implements RTS/CTS (Modem Clear To Send) handshaking. This switch is strongly RECOMMENDED if you do not use F+. BBS Onliner Interface - Specific BBS Installation Examples and Notes This is where you can help. I need samples. Please send me your setup. Generic Installation Batch File Example Until more examples arrive please check WWIV example. Command Line Example Until more examples arrive please check Searchlight example. 2 A.M. BBS The /2 option reads JUMPER.DAT. Installation example not available. Auntie BBS The /7 option reads a file called AUNTIE.SYS. My information on Auntie BBS is extremely limited, and you will also need to supply the door with the communications information (/C or /I). Installation example not available. DoorWay to Unlimited Doors The /S options reads the "short" DOOR.SYS file. Installation example is not available. EIS-PC The /Rx option reads DORINFOx.DAT. Installation example is not available. Force The /S options reads the "long" DOOR.SYS file. This is a proposed standard format for drop files. Installation example is not available. FoReM The /Rx option reads DORINFOx.DAT. Installation example is not available. Forum The /F option reads USERINFO.TXT. Installation example not available. GAP The /S options reads the "long" DOOR.SYS file. This is a proposed standard format for drop files. Installation example is not available. Genesis The support for Genesis' CALLINFO.BBS is untested. If you try this /G option, please let me know whether or not it works. GT The /S options reads the "short" DOOR.SYS file. Installation example is not available. Maximus The BOI is able to read many of the various drop files that Maximus can create. I would really appreciate it if I could get hold of a few installation examples. ModuleX The /M option reads NUMBER.TXT. Installation example not available. OLEcom The /Rx option reads DORINFOx.DAT. Installation example is not available. Opus-CBCS 1.13 My documentation on Opus 1.13's drop file(s) is incomplete. I'd appreciate any help. Opus-CBCS 1.14 The /Oxx option reads LASTUSxx.DAT (where xx is the Opus task number in hexadecimal, if xx is not present the door looks for a file called LASTUSER.DAT.). Example: doorgame /o0e:c:\opus\ the c:\opus\ tells it to look for LASTUS0E.DAT in the C:\OPUS\ directory. Complete installation example is not available. PCBoard 12.x The /1 option reads PCBOARD.SYS. My documentation on this file is incomplete, and I'd appreciate any additional information. Installation example not available. PCBoard 14.x The /P option reads PCBOARD.SYS. As per PCBoard specifications the BOI will blank out most of this file if the user drops carrier while in the door. Installation example not available. Phoenix The /H option reads INFO.BBS. Installation example not available. ProBoard I would really appreciate any information about dropfiles that ProBoard creates. Installation examples would also be nice. QuickBBS The /Rx option reads DORINFOx.DAT. Installation example is not available. RBBS The /Rx option reads DORINFOx.DAT. The follow installation example is courtesy of Arnold Robinson. RBBS directory -> C:\RBBS batch file directory -> C:\RBBS batch file -> DOORGAME.BAT doorgame directory -> C:\RBBS\DOOR (DOORGAME.EXE, DOORGAME.INS, DOORGAME.LNG, DOORGAME.KEY) bulletins directory -> C:\RBBS\BULLETIN RBBS config parm 109 -> DOORS.DEF Put this line in C:\RBBS\DOORS.DEF "DOORGAME",10,,D,"DOORGAME.BAT",N,,30 what the values mean (most are optional), the values ar not necessarily recommendation, merely what Arnold uses. "DOORGAME" - name of door 10 - securitly level (blank) - questionaire to execute D - "D"rop or "S"hell to door "DOORGAME.BAT" - batch file to run N - ask for password on return (Y/N) (blank) - file to display on return 30 - max time allowed in door C:\RBBS\DOORGAME.BAT listing @echo off cd c:\rbbs\door doorgame /r1c:\rbbs\ /yc:\rbbs\bulletin\ /q /x:2 /a /b cd c:\rbbs Remote Access Remote Access can run doors in several different ways (Type 7, Type 15, command line). The BOI should be able to handle all of those using either DORINFOx.DAT or DOOR.SYS. I would appreciate any installation examples. The /Rx option reads DORINFOx.DAT. RyBBS The /5 option reads CURRUSER.BBS. Installation example not available. Sapphire My documentation on Sapphire's SAPPHIRE.DAT is incomplete. I would appreciate any further information on what dropfiles that Sapphire creates. Searchlight I do not have any information regarding any drop files that Searchlight creates. Command Line Example The BOI allows BBSes to pass information to it via command line. This bypasses the need for batch files. By using the /9 switch, the BOI knows to get the information it needs from the command line. The /9 tells the BOI where to find the door and its associated files. For example c:\slbbs\games\doorgame /9 This command tells the BOI that all extra files (data files, hall of fames, etc...) should be kept in c:\slbbs\games\. You will also need to tell the BOI the user's name, the amount of time the user has left, and the commport. You might try the following: c:\slbbs\games\doorgame /9 /n%U /z%M /c:%P (...) The %U passes the door the users name (Andrew_Mead), the %M passes the time remaining in minutes, and the %P tells the door what commport is in use. The elipses (...) just represents the other switches you might choose to use. Simplex The /Rx option reads DORINFOx.DAT. Installation example is not available. Spitfire The /6 option reads SFDOORS.DAT. Installation example is not available. TAG The /Rx option reads DORINFOx.DAT. Installation example is not available. Telegard I believe that Telegard creates CHAIN.TXT, and installation is probably similiar to that of WWIV. TPBoard The /Rx option reads DORINFOx.DAT. Installation example is not available. Virtual Virtual BBS can create several different drop files. Here is an example (courtesy Patrick Murray). I recommend using the /4 (CHAIN.TXT) command, as it shows both user name and handle. You can also use /Rn (DORINFOn.DEF) and /S (long DOOR.SYS). CHAIN.TXT directory -> C:\VBBS batch file directory -> C:\VBBS\GAMES batch file -> DOOR.BAT doorgame directory -> C:\VBBS\GAMES\DOOR (DOORGAME.EXE, DOORGAME.INS, DOORGAME.LNG, DOORGAME.KEY) bulletins directory -> C:\VBBS\GAMES\HOF VConfig / Doors settings 1. Program Name: DoorGame (ANSI) 2. Command Line: C:\VBBS\GAMES\DOOR.BAT C:\WWIV\GAMES\DOOR.BAT listing @echo off cd c:\vbbs\games\door doorgame /4c:\vbbs\ /yc:\vbbs\games\hof\ /q /x:2 /a /b cd c:\vbbs WildCat! The /W option reads CALLINFO.BBS. Installation example is not available. WWIV The /4 option reads CHAIN.TXT. This is the setting that I use on my BBS (The Infinite Improbability BBS, @9952 WWIVnet). The sample is for DOORGAME.EXE CHAIN.TXT directory -> C:\WWIV batch file directory -> C:\WWIV\GAMES batch file -> door.bat doorgame directory -> C:\WWIV\GAMES\DOOR (DOORGAME.EXE, DOORGAME.INS, DOORGAME.LNG, DOORGAME.KEY) bulletins directory -> C:\WWIV\GFILES\HOFSDIR //CHAINEDIT settings A. Description : DoorGame (ANSI) B. Filename : C:\WWIV\GAMES\DOOR.BAT E. ANSI : Required <--- Optional F. DOS Interrupt: NOT Used <--- You need this G. 300 Baud : NOT Allowed <--- Recommended H. Shrink : No <--- loads faster C:\WWIV\GAMES\DOOR.BAT listing @echo off cd c:\wwiv\games\door doorgame /4c:\wwiv\ /yc:\wwiv\gfiles\hofsdir\ /q /x:2 /a /b cd c:\wwiv BBS Onliner Interface - Other Notes DESQview The BBS Onliner Interface is DESQview aware. It will give up time to other applications while waiting for input. If the internal async routines are active, it will also alert DESQview when it is in a critical state. Some notes are filtering in about QEMM complaining about the command line. One user stated he got the door working by removing the extraneous colons from the command line. /sc:\bbs\ instead of /s:c:\bbs\ I do not understand any of this, but it might help you out. If anyone can document any problems with QEMM or DESQview please contact me. Windows, OS/2 and other DOS multitaskers The BBS Onliner Interface will give up time slices to all DOS based multitaskers that play by DOSes rules. I have verified reports that since this capability was added, Windows sessions in other windows are now much, much faster. File Sharing/Locking The BBS Onliner Interface now supports rudimentary file sharing and locking. If the author of the doors has used the built in file handling routines, then the door should run well in multi- node environments. What Went Wrong??? (or "Jane, how do I turn this thing off?") Program Crashes at end of game. You probably have a corrupted Hall of Fame data file. Check the door specific documentation as to what files might be involved. Error messages Currently defined error messages that you will find in BOIERR.LOG, their causes, and possible solutions. error explained 2 Unkown or incorrect argument on command line. 3 Unsupported file format. Please send me any and all information you might have on your BBS software's drop file, and I'll add support for it. 4 Unable to find file. 5 Error in file. This means that file does not match the structure that I have for it. If you are using a DOOR.SYS drop file, try using the other one (/S /D) 7 Duplicate directives. 8 Path/Filename for Hall of Fame is not valid. You have given the /Y switch an invalid path/filespec. 9 Path not valid. 11 Invalid or missing number in /X:nn switch. 12 /X:nn value out of range. This must be between 1-19. 13 Invalid or missing value in /C:n. "n" must be a valid port number. 1 to 4 if you are not using a FOSSIL driver, and 1 to 8 if you are. 16 /L can not be used with either /C or /I. 17 Invald format in /I:i:nnnn. The nnnn must use all four spaces. 18 Invald hexadecimal in /I:i:nnnn. 19 Invalid numeric in /A:x. 20 /A:x time value must be at least 5 minutes. 31 Unable to find/initialize FOSSIL driver. Please notify me, and check your setup. This switch should only occur if you use the F+ switch. Sections Command Line Parameters Reference BBS Drop File Commands Communications Directives Local Play FOSSIL Communications Internal Asynchronious Communications Additional Communication Directives Configuration Directives SysOp Function Keys BBS Onliner Interface - Command Line Parameters Reference Notice - This is a listing of all parameters available in the BBS Onliner Interface. Not all of these commands may be available or have any meaning for the door you are installing. Also note that on the commands that take additional parameters, that the initial colon (:) is usually optional, and is only used for clarity. BBS Drop File Commands The BOI automatically reads many common drop files, as well as being able to accept command line parameters directly from the BBS. Please check the list below for a dropfile created by your BBS software. See INSTALL.BOI for specific information and examples. This list is far from comprehensive, and I encourage any and all of you to send me samples of your installation, or information about what drop file(s) your BBS can create. command dropfile BBS software - Notes /1 PCBOARD.SYS PCBoard 12.x (see /P) /2 JUMBER.DAT 2 A.M. /3 OPUS 1.13 (not available) /4 CHAIN.TXT WWIV, VBBS, TAG, Telegard /5 CURRUSER.BBS RyBBS /6 SFDOORS.DAT Spitfire BBS /7 AUNTIE.SYS Auntie BBS (same format as /1) /8 Sapphire BBS (not available) /9 command line Searchlight, Remote Access, Simplex /D DOOR.SYS DoorWay to Unlimited Doors, GT NOTE:This is the "Short" Door.Sys see /S /F USERINFO.TXT Forum /G CALLINFO.BBS Genesis (beta) /H INFO.TXT Phoenix /M NUMBER.TXT ModuleX /O LASTUSER.DAT Opus 1.14 /Oxx LASTUSxx.DAT Opus 1.14 where "xx" is the task number in hexadecimal /P PCBOARD.SYS PCBoard 14.x (see /1) /S DOOR.SYS GAP, Force NOTE: This is the "Long" Door.Sys see /D /W CALLINFO.BBS WildCat!, Telegard /R DOORINFO.DEF DorInfo is the most widely used file. /R# DORINFO#.DEF EIS-PC, FoReM, OLEcom, QuickBBS, RBBS, Remote Access, TAG, TPBoard, UBBS, and VBBS. the "#" represents the node number If this command is missing, the door will default to local mode. Drop File Path If (as recommended) you do not run your online doors from your BBS directory, you need to tell the BOI where to find the drop file. You can either copy the file, or add the drop file's path to the command line. Here's an example with WildCat! assuming the BBS is in c:\wcat. doorgame /w:c:\wcat\ Note: the "\" on the end of the path is required, and that the first ":" (w:c) is optional (for clarity). The BOI reads user name, user time remaining, user comm port, and (where available) user handle, user screen size, and if the user is on the local console. Communications Directives Left to its own, the interface will normally detect local play from the drop file. The override switches (/C, /I, /L) should only be used with great care. LOCAL play The BOI will normally sense local play, but you can force it command effect /L Force LOCAL mode. Can NOT be overridden. If either /c or /i is present the door will exit. FOSSIL Communications FOSSIL communications are automatically sensed and used if present. You can, however, influence, their use. You should also note that there are NO slashes (/) before these FOSSIL commands. command effect F- Do NOT use FOSSIL (/i command gives same result) F+ Force FOSSIL use. (ignored if /i command present) If FOSSIL not found, door will exit. F@ Deinitialize FOSSIL when through. By default, the BOI keeps the FOSSIL "hot". This can be combined with the above option (F+@). /C:n comport to use (see /C:n below). Internal Asynchronious Communincations The BOI contains its own fully functional communciations library that is very configurable. If FOSSIL is either disabled or not found, these routines will be used. command effect /B Locked BAUD (DTE-DCE) rate. If you are running your modem with a "locked" baud rate, you will NEED to add this command to your command line. The internal routines use RTS handshaking by default. This switch tells them to use CTS/RTS handshaking which prevents modem overrun. /C:n Serial port to use. You can force the program to use a given serial port. Valid values are from 1 to 8. (NOTE: 5 to 8 are only defined if the FOSSIL is also used). This command is necessary if the drop file is wrong, or you are using command line directives only. If /l or /i is present the door will exit. /I:x:nnnn Non-standard IRQ specification. If you are not using FOSSIL, and you do have a non-standard serial port configuartion, you can use this option to specify your IRQ/port address info. The default settings, would be equivalent to Com1 : /i:4:03f8 Com2 : /i:3:02f8 Com3 : /i:4:03e8 Com4 : /i:3:02e8 The 'x' is the IRQ number. It is a hexidecimal value from 0 to f. 'nnnn' is the port address for communications. It is a 4 digit hexidecimal value If this command is present, the FOSSIL routines will not be used. If /c or /l is present the door will exit. Additional Communications Directives command effect /K Do NOT check for Carrier detect. This should only be used in dire cases. If this switch is used, the door may not time out if the remote user hangs up the phone. If your modem does not properly maintain a Carrier Detect signal, the game will automatically abort. This option supresses this activity. If you are forced to use this option, you probably are having hardware problems with the modem, RS-232 connector (bad pin or broken wire), or modem cable. Configuration Directives command effect /A Play Again? (default x=10) /A:x If this mode is present, it is available with the door you are using, and the user has more than x minutes remaining, they will be asked if they wish to play again. /N:... User Name (ie: /n:Doc_Technical) This option allows you to pass the door the user's name through the command line. This is handy for BBSes like Searchlight, or if you are playing locally from DOS. Underscores are converted to spaces. /Q Quiet Local Mode This will prevent all ^G bells from ringing the local console. (Unless the door author specifically overrides it). This option will help SysOps get full nights worth of sleep. /Z:x User Time Limit x is an amount of time between 10 and 50. The user's time allowed will be the lesser of this value, and the amount found in the BBS drop file. /X:n Limit Hall of Fame listings You can limit the time any one name appears in the monthly top 20 with this switch. The default is no limitation. The recommended limit is 1 or 2. This keeps a small number of players from monopolizing the game. If an occassional (non-fanatical) is more likely to see his name listed, he is more likely to play the game. n is any number from 1 to 19. /Y Alternate path/filespec for text Hall of Fame /y:<pathspec>\ (ie: /y:c:\wcat\bulls\) In the sample above, the text Hall of Fame (if applicable) will be placed into c:\wcat\bulls using the default name (found in the games docs). /y:<filespec> (ie: /y:c:\wcat\bulls\bull4.bbs) In the sample above, the text Hall of Fame will be placed in c:\wcat\bulls, and it will be named bull4.bbs. A+ Enable AVATAR/1. NOTE: The AVATAR codes are relatively untested. If you use this switch, please let me know whether it works or doesn't. SysOp Function Keys The SysOp is afforded the following SysOp functions. keypress action F2 Toggle User Status Line. This will toggle between the following current modes: Display Time Remaining (default) Display Active Communications (FOSSIL or internal) Display Remote graphics (ASCII, ANSI, AVATAR/1) F7 Decrement (reduce) user's time remaining by 1 minute. F8 Increment (increase) user's time remaining by 1 minute. F9 Drop Carrier. (Fake line noise). This will disconnect the current communications and send the user a string of random characters to simulate line noise. F10 Force return to BBS. This sends the user a notice informing them that the SysOp has terminated the session. It then returns control to the BBS. (Ctrl-Break) will also exit the game, but not as pleasently.