home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / stkeep / stk_prg / bbsfiles.doc < prev    next >
Text File  |  1992-08-28  |  7KB  |  236 lines
  1. ST-Keep System Files Format Reference
  2. Copyright 1991 by Andrew P. Studer
  3.  
  4. Updated:  07Aug92
  5.  
  6. * WARNING *  This file contains information critical to the security
  7.              of your BBS, do not hand it out freely.
  8.  
  9. NOTE:  Use this information with extreme caution, I will not be
  10.        responsible for loss of data due misuse or inaccuracy of this
  11.        document.
  12.  
  13. ****************
  14. *** STK_INFA.SYS - This file contains various defaults for the BBS.
  15. ****************
  16.  
  17. Key:   * = DO NOT MODIFY THIS LINE, SYSTEM CRITICAL INFORMATION
  18.  
  19.        $ = CHANGE ONLY IF YOU MOVE THE CORRESPONDING FILES
  20.  
  21. Line #  Description
  22. ------  -----------
  23.  
  24.   1     Maximum baud rate code:
  25.  
  26.            0 = 19200    1 =  9600    2 =  4800
  27.            4 =  2400    7 =  1200    9 =   300
  28.  
  29.          192 = port locked at 19200
  30.    
  31.   2  *  Maximum userlog size
  32.  
  33.   3  *  Maximum number of rooms
  34.  
  35.   4  *  System flags - bit 0 = unused
  36.                            1 = append new users if userlog full?
  37.                            2 = allow deletion of msgs in room 4 and
  38.                                the system activity room?
  39.                            3 = allow users to create rooms?
  40.                            4 = install new user accounts?
  41.  
  42.   5  *  System flags - bit 0 = secure mode?
  43.                            1 = local logon ATS0=0 on / ATH1 off
  44.                            2 = file transfer verbose?
  45.                            3 = unused
  46.                            4 = unused
  47.                            5 = status line @ logon?
  48.                            6 = chat mode disabled?
  49.                            7 = bbs disabled?
  50.  
  51.   6     Number of calls since system initialization
  52.  
  53.   7     Chat exec path/filename
  54.  
  55.   8  *  Maximum number of messages per room
  56.  
  57.   9     System Password
  58.  
  59.  10  $  System files pathname (BBS.PRG & *.SYS files)
  60.  
  61.  11  $  Blurb files pathname (*.BLB)
  62.  
  63.  12  $  Help files pathname (*.HLP)
  64.  
  65.  13  $  Bulletin files (*.BU?)
  66.  
  67.  14  $  Vote files (*.VOT, *.ANS)
  68.  
  69.  15  $  File transfer executable pathname (XYZ.TTP)
  70.  
  71.  16     Pathname for temporary files
  72.  
  73.  17     Post-logon exec door number
  74.  
  75.  18     Unused
  76.  
  77.  19     Door to run if * pressed, null for door menu
  78.  
  79.  20     BBS Name
  80.  
  81.  21     Modem initialization string:
  82.  
  83.            Requires - ATS0=1 to answer on the first ring
  84.                       ATS2=255 to disable remote control of the modem
  85.                       DCD should not be set to always on
  86.  
  87.  22     Current message miscellaneous comment field
  88.  
  89.  23     Default time limit, in minutes, for new users, 255 = unlimited
  90.  
  91.  24     Default download ratio for new users, 255 = unlimited
  92.  
  93.  25     SysOp's first name
  94.  
  95.  26     SysOp's last name
  96.  
  97.  27     Logoff Exec door number
  98.  
  99.  28     Unused
  100.  
  101.  29     Room number where ST-Keep will save download messages, 0=room 3 
  102.  
  103.  30     Drive/path/filename of STZIP.PRG for verbose listing
  104.  
  105.  31     Drive/path/filename of LHARC.TTP for verbose listing
  106.  
  107.  32     Password to bypass disabled bbs
  108.  
  109. ****************
  110. *** STK_INFB.SYS - Contains message base information
  111. ****************
  112.  
  113. * WARNING *  Never edit this file or you will destroy the integrity
  114.              of your message base.
  115.  
  116. Line #  Description
  117. ------  -----------
  118.  
  119.   1     Total number of bytes written to the message file
  120.   2     Oldest message number in the message file
  121.   3     Number of the next message to be written to the message file
  122.   4     File offset location to write the next message
  123.  
  124. ****************
  125. *** STK_INFC.SYS - Contains ST-Keep color palette data
  126. ****************
  127.  
  128. 32 bytes of information, 2 bytes for each color register (0-15) used 
  129. by the ST's setpalette() routine (XBIOS #6).
  130.  
  131. ****************
  132. *** STK_HDRS.SYS - Room header information
  133. ****************
  134.  
  135. Each line in this file contains the room header for the relative room 
  136. number.  Line 1 contains the header for the Lobby, line 2 for Mail, 
  137. etc.  [R][I] shows the room number you are in.  If used, this file 
  138. must contain a number of lines equal to the maximum number of rooms 
  139. in your system with blank lines for rooms without headers.
  140.  
  141. *************** 
  142. *** STK_ARC.SYS - Room archive filenames
  143. ***************
  144.  
  145. Each line in this file contains the pathname/filename of each room 
  146. that is being archived.  If used, this file must contain a number of 
  147. lines equal to the maximum number of rooms in your system with blank 
  148. lines for rooms that aren't being archived.
  149.  
  150. ***************
  151. *** STK_GRP.SYS - Group names
  152. ***************
  153.  
  154. 15 lines, each containing the name of the relative group.  If the 
  155. group is unused the line must be blank. 
  156.  
  157. ****************
  158. *** STK_ROOM.SYS - Room data
  159. ****************
  160.  
  161. This block of data is repeated a number of times equal to the maximum 
  162. number of rooms.
  163.  
  164. Offset    Description
  165. --------  -----------
  166.  1 - 30   Name, space padded to the right
  167. 31 - 60   Directory pathname, space padded to the right
  168. 61        Generation number, 0=inactive, 1-255 gen
  169. 62        First flag
  170. 63        Second flag
  171. 64        Group number, if non-zero this room is only available to
  172.           users of this group
  173. 65        Floor number that it exists on
  174.  
  175.           The following two fields are repeated for each message in 
  176.           the room.  If your system has 50 messages per room, this 
  177.           group of bytes will be repeated 50 times before the next 
  178.           room information structure begins.
  179.  
  180. 66 - 69   Message number 
  181. 70 - 73   Message location
  182.  
  183. ****************
  184. *** STK_USER.SYS - User account information
  185. ****************
  186.  
  187. This block of data is repeated a number of times equal to the maximum 
  188. number of user accounts.
  189.  
  190. Offset    Description
  191. --------  -----------
  192.  1 - 20   Password
  193. 21 - 50   Username
  194. 51 - 70   Personal Comment field
  195. 71 - 83   Phone Number
  196. 84        Access Level
  197. 85 - 86   Number of calls (hi/low)
  198. 87 - 88   Last call date (hi/low MS/DOS format)
  199. 89 - 90   Last call time (hi/low MS/DOS format)
  200. 91 - 100  Users birth date (mm/dd/yyyy format)
  201. 101       Unused
  202. 102       Minutes per day
  203. 103       Minutes left today
  204. 104       Screen width
  205. 105       Userflag A
  206. 106       Userflag B
  207. 107 - 117 Unused
  208. 118 - 199 Download count (hi/low)
  209. 120 - 121 Upload count (hi/low)
  210. 122       Upload protocol
  211. 123 - 124 Number of messages written (hi/low)
  212. 125       Download ratio
  213. 126 - 127 Unused
  214. 128       Graphic emulation (0=ascii, 1=vt52, 2=ansi)
  215. 129 - 130 Group bits (0-15)
  216. 131       Tab spaces (0+)
  217. 132 - 134 Unused
  218. 135 - 164 Real Name
  219. 165 - 184 City, State
  220.  
  221.           The following two fields are repeated a number of times 
  222.           equal to the maximum number of messages allowed in each
  223.           room.  These are user mail pointers.
  224.  
  225. 185 - 188 Message number
  226. 189 - 192 Message location
  227.   
  228.           The following two fields are repeated once for every room 
  229.           on the BBS.  This includes unused room slots.
  230.  
  231. 193       Generation number for this room
  232. 194 - 197 Last message read in this room
  233.  
  234.  "     "  Next user structure
  235.  
  236.