home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / bbs / fminibbs / mini_bbs.doc < prev    next >
Text File  |  1990-11-06  |  13KB  |  261 lines
  1.                               FLASH MINI BBS V 2.0
  2.  
  3. FLASH MINI BBS is a BBS that uses Flash's scripting language.  If you have
  4. Flash, then you have the means to run this BBS.  MINI BBS, has passwords,
  5. online help, mail, upload and download files X or Z modem, feedback to
  6. SYSOP, file descriptions, the ability run: online games,a CLI, and use
  7. Zmodem transfers (use ZMDM_GEM.LZH available on GEnie).
  8.  
  9. MINI BBS creates a log to keep track of callers, what they uploaded and
  10. file descriptions, downloaded, if a new user wants a password, etc. It also
  11. creates a file for feedback.
  12.  
  13. After unarcing you should have these files:
  14.  
  15.  filename                   description
  16. MINI_V2.DO        ** Flash Mini BBS **
  17. MINI_V2A.DO       ** Flash Mini BBS to Auto-Run on boot-up **
  18. MB_SETUP.DO       ** Do file to make MINI.CFG file **
  19. MINI.CFG          ** Sample configuration file made by MB_SETUP.DO **
  20. USER.LST          ** Sample User/Password list (see below for details) **
  21. MAIL.LST          ** Sample Mail list (see below for details)  **
  22. FILELIST.TXT      ** Sample file description list **
  23. HELP_MG1.HLP      ** Help message -General- ** 
  24. HELP_MG2.HLP      ** Help message -Rooms- **
  25. HELP_MG3.HLP      ** Help message -Passwords- **
  26. HELP_MG4.HLP      ** Help message -Mail- **
  27. AUTOEXEC.BAT      ** File to use with PCOMMAND.ARC available on GEnie **
  28. **************************
  29.  
  30.       A word about paths.  Those who are familiar with paths can skip this
  31. part. When I started using the ST I had very little experience in the
  32. MS-DOS world and was very unfamiliar with paths.  I remember some programs
  33. asking me for paths and in some instances I was unable to run the program.
  34. Since then I have learned abit, so let me pass on any knowledge to you.
  35.  
  36. Paths have a standard form: EG.    A:\, or C:\, or even F:\FLASH\TEMP\ .
  37. A path starts off with a Drive Letter, as above the A, C, or F.  Drive A
  38. would be floppy drive A and Drives C and F could be Hard Drives or a Ram
  39. Disk.  Following each drive letter is a colon : .  After each colon is a
  40. backslash \ (the key is to the right of the Return key).  If a path is
  41. specifying a file on the "Root" directory (this would be on the disk
  42. outside of any folders) then  A:\ or C:\ or F:\ would be the path needed.
  43. If you were asked to specify a file name and a path, the file name a period
  44. and the file extension would be placed after the \ .  EG. A:\FLASH.PRG or
  45. C:\MINI.CFG and so on.
  46.  
  47. If the path was specifying something not in the "Root" directory, but in
  48. folders on the disk you would add the folder name and a \.  So if you
  49. wanted something on Disk C inside the FLASH folder then the path would be
  50. C:\FLASH\   .  If you had another folder inside the FLASH folder like ROOM2
  51. and wanted to go to that path, then the path would be C:\FLASH\ROOM2\ .  If
  52. the path was inside another folder inside the ROOM2 folder (lets call it
  53. MAIL) you would add the folder name and a \ to the path that path
  54. C:\FLASH\ROOM2\MAIL\  .  If you need to specify a file, add the filename, a
  55. period and the extension after the final \  . 
  56. C:\FLASH\ROOM2\MAIL\FLASH.PRG  .  I know this information would have helped
  57. me, so if it has helped you...GREAT!
  58.  
  59. *********************************
  60.  
  61.       The 3 DO files have 3 different functions.  MINI_V2.DO runs the
  62. MiniBBS, but needs input from the user before it will run.  It is not good
  63. to use this as an auto-run do program.  MINI_V2A.DO is a auto-run do file,
  64. however, it needs to be altered to run on your system.  MB_SETUP.DO creates
  65. a configuration file for use with either of the above MINI do files.
  66.  
  67.       MINI.CFG is a sample configuration file.  With my Hayes compatible
  68. modem I used the modem initialization string as ATS0=0,V1 which sets
  69. auto answer off, and send engligh responses from the modem.  My modem sends
  70. the string RING when the phone rings.
  71.  
  72. *********************************
  73.  
  74.       USER.LST is the password and mailbox list.  The list is created in
  75. the Flash text editor and saved. The Users name can be upto 80 letters
  76. long, passwords can only be 8 and can only use letters, numbers and the _
  77. key (shift -).  Each line must be followed by a return and format is:
  78.  
  79. user name
  80. password
  81. user name
  82. password
  83.  
  84. the first 4 users should be:
  85. SYSOP      password SYSOP    *for mail purposes*
  86. your name  password ?        *same as password for FULL in config file*
  87. SHUTDOWN   password ?        *your choice*
  88. PCSHELL    password ?        *your choice*
  89.  
  90. You can add to this list whenever needed.
  91.  
  92. For Mail purposes Mini uses the password as a mail address.  This is the
  93. reason why passwords are limited to 8 letters.  When mail is addressed Mini
  94. BBS finds the User from the user list and gets his password and each letter
  95. is saved as PASSWORD.ML1, .ML2, .ML3, .ML4, .ML5 or .ML6.  
  96.  
  97. Example: if mail is being sent to JOHN SMITH, Mini will search User.lst
  98. for JOHN SMITH.  If the name is found then Mini will get his password, say
  99. SPARKY_1, depending on how many letters are in the box the letter would get
  100. saved as SPARKY_1.ML? (1-6).  If the name JOHN SMITH was not found then
  101. caller would be told to check the mail list to see it mail was addressed
  102. properly.
  103.  
  104. So it is clear that if a User and password hasn't been added to the
  105. USER.LST he can not receive mail.
  106.  
  107. ********************************
  108.  
  109.       MAIL.LST is just a list of users names that have access to Mail. 
  110. This way a person can check to see the name of the person to send mail to.
  111. This file can be created in a text editor (like Flash's) and saved in ASCII
  112. format (like Flash).   Each name must be followed by a return.  Format is:
  113.  
  114. SYSOP
  115. JOHN SMITH
  116. Bob Brodie
  117. Darlah PINE
  118.  
  119. ********************************
  120.  
  121.       FILESLIST.TXT is a text file of files available for downloading and a
  122. short description of each file.  Keep the length of a line to 80 as more
  123. that 80 character won't be dispalyed.  See the example file. 
  124.  
  125. ********************************
  126.  
  127.       HELP_MG1.HLP, HELP_MG2.HLP, HELP_MG3.HLP, HELP_MG4.HLP are sample
  128. help messages you can have on your board.  This gives online help.  Keep
  129. each file to less than 24 lines otherwise it will scroll off the screen.
  130.  
  131. ********************************
  132.  
  133.       AUTOEXEC.BAT is a batch file to make PCOMMAND.PRG work with Mini BBS.
  134.  
  135. ********************************
  136. ********************************
  137.  
  138.                         RUNNING FLASH MINI BBS
  139.  
  140. First decide where you will have files for ROOM1, ROOM2, and
  141. MAIL/PASSWORD.  If you plan on having games available you will need to
  142. decide where to put those. Create those folders if needed.  Now start
  143. FLASH.PRG.  Run the MB_SETUP.DO file from the terminal window either by
  144. hitting ALT A and selecting the file with the GEM item selector.  Or with
  145. the command line type DO (the path if needed) and MB_SETUP.DO.  Enter the
  146. information you are prompted for.
  147.  
  148. Load in the USER.LST into the FLASH capture buffer and modify this list for
  149. your needs.  Make sure the password you choose for you (the SYSOP) is the
  150. same that you entered in the MB_SETUP as password for FULL access.  Also
  151. change the password for SHUTDOWN and PCSHELL.  Delete those sample names
  152. from the list.  Save the file as USER.LST and place it in the Mail room.
  153.  
  154. Load in the MAIL.LST and add your names, deleting all the sample names. 
  155. Leave SYSOP in the file so people will see mail can be addressed to SYSOP.
  156. Save this file as MAIL.LST and place it in the Mail room.
  157.  
  158. To use the command line interpreter, you must have one that supports
  159. redirection.  PCOMMAND.PRG from GEnie (file name PCOMMAND.ARC)  will do
  160. this.  Put PCOMMAND.PRG and the AUTOEXEC.BAT in ROOM1.  If you use any
  161. other CLI you will need to modify the line in MINI_V2 or 2A.DO to execute
  162. the CLI you want.  This line is approximately 400.
  163.  
  164. Place all the HELP_MGs.TXT in ROOM1.
  165.  
  166. Load the FILELIST.TXT and modify it to suit your needs.  Place this file in
  167. ROOM2.
  168.  
  169. If you will use online games, you will need to modify the MINI_V2.DO  or
  170. MINI_V2A.DO (which ever you will be using) to run the games you want. 
  171. Depending on which version you are modifying the Games are around line 325. 
  172. Change the lines for default paths, games programs to execute, also change
  173. the games menu (apprx line 315) to reflect any changes.  I will UL to GEnie
  174. the program I have used here.  (NOTE:  I do not endorse this game, it is
  175. the one I tested with MiniBBS).
  176.  
  177. If you use any other Zmodem program other than SZ.PRG to send and XYZ.TTP
  178. to recieve you will need to change lines (approx) 580 and 680 to reflect 
  179. those changes.  Because RZ.PRG opens a dialoge box if it encounters any 
  180. problems I do not reccomend using RZ.PRG to receive uploads.
  181. If you use MINI_V2A.DO you will need to add your BBS name to line 4 and the
  182. path and configuration file name in line 5.
  183.  
  184. Finally use the Search and Replace function in Flash to Search and repalce
  185. any >** with >.  This will remove the 2 astiricks from each line.  This
  186. will change the line >**IF ~CA JMP SendThemAway| (which is now just a
  187. comment and not a working line) to >IF ~CA JMP SendThemAway| which is a
  188. working line that tests to see if the modem is still connected.  To use
  189. MINI BBS on a null modem cable you will not want those lines working as
  190. there is no Carrier over a null modem cable.
  191.  
  192. If you add or change any of the HELPMGs.HLP you will need to change thier 
  193. title, etc.  These lines are approx around #1040.
  194.  
  195. Of course, save these changes.
  196.  
  197. Make sure your modem is connected and turned on and run the MINI_V2 DO.
  198. IF you are running the non-auto version you will get the opputronity to
  199. create a new configuration file or change the old one.  Also you must also
  200. enter the BBS name and enter the path and name of your config file.  If
  201. you are running the auto-run able file the config file name and path and 
  202. the BBS name must have been entered.
  203.  
  204. MINI BBS will create a log to keep track of callers, what they uploaded and
  205. file descriptions, downloaded, if a new user wants a password, etc.  That 
  206. file is MINIBBS.LOG.  Do not delete this file while Mini is running as the
  207. file is created on the start up of Mini.  If no file exist then none of the
  208. log gets saved.
  209.  
  210. BBS will also created a file FEEDBACK.TXT if anyone leaves feedback.  Both
  211. of these files can be viewed remotely using the PC option, and when in the
  212. CLI using the TYPE function to list the file to your screen.  I have also
  213. added a feature to read the FEEDBACK.TXT from Room1.  When the SYSOP logs
  214. on and there is a file FEEDBACK Mini will announces there is Feedback.  To
  215. view feedback use the view function in Room1.  Both files can also be
  216. loaded into the capture buffer, after you have shut down MINI BBS, and read
  217. there also.  These file do not need to exist on start up as MINI BBS will
  218. create them if needed.  
  219.  
  220.            ** A note about these files ** 
  221. Because I used append block to add to these files when needed, sometimes
  222. (at least on my 4 Meg MEGA with a T16) random letters will show up in the
  223. file.  I have tried to keep these letters from affecting input into these
  224. files by the using extra returns.  Hopefully these misc. letters and
  225. numbers will not affect the readability of these files.
  226.  
  227. The difference between downloading a file from Room1 and Room2, other than
  228. Room1's DL feature is only available to SYSOP, is Room2's download feature
  229. will only let files be downloaded from Room2.  Room1 can specify any disk
  230. dive and file.  This way SYSOP can DL any file.  Of course that file could
  231. be copied from anywhere to Room2 using the CLI.  This is the reason why I
  232. have only supported Xmodem from Room1.
  233.  
  234. That should be it (if I haven't forgotten anything).
  235.  
  236. *****                  DISCLAIMER                  *****
  237.  
  238. I have tested this a much as I could on my system, and have had no problems
  239. with it affecting my system.  I can not take responsibility for its use on
  240. any other system.  I give no guarentee, either expressed, written or
  241. inplied.  USE AT YOUR OWN RISK.
  242.  
  243.                   List of Variables used
  244.  
  245. A  non specific            J  BBS name               S  Path Mail/Password
  246. B  User logon password     K  not used               T  Path Room2
  247. C  non specific            L  not used               U  PW check variable
  248. D  Disk input variable     M  Access String          V  Abort Shutdown var
  249. E  non specific            N  Incomming baud rate    W  Callers logon name
  250. F  Default path Room1      O  Mail variable          X  PW check variable
  251. G  Max baud rate           P  CLI, Shut Passwords    Y  PW for Limited use
  252. H  Modem initialzation     Q  logon contro var       Z  PW for Full use
  253. I  Ring string             R  not used
  254.  
  255.  
  256. Since most of my testing was via null modem cable I might have missed some
  257. problem.  I have had a few friends test the file and it seems solid. If
  258. you come across any problem, suggestions, or whatever, please let me know. 
  259. GEnie Mail address is C.EISENSCHMI, my address on the Sacramento ST Users
  260. Group BBS is Ike Eisenschmidt (phone number 916-729-2968).  Thanks and have
  261. fun.