home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / SWAP40.ZIP / SWAP.DOC < prev    next >
Text File  |  1995-06-01  |  35KB  |  727 lines
  1.                            *****  SWAP v4.0  *****
  2.                                 (01 June 1995)
  3.  
  4.               GOODBYE/HELLO/HOLIDAY Screen Rotator for Wildcat!
  5.  
  6.                           Written By: Terry Atkinson
  7.                               Adsum Wildcat! BBS
  8.                                 Dartmouth, NS
  9.                         NODE 1 902-434-3121 (must be verified)
  10.                         NODE 2 902-435-2455 (must be verified)
  11.                         NODE 3 902-434-2350 (Donors Only)
  12.                         VOICE: 902-434-1346
  13.                         USR DS V.34
  14.  
  15. What it does:
  16. ============
  17.      SWAP is designed to be used on a Wildcat! (or any other) BBS for rotation
  18. of HELLO and/or GOODBYE ANSI/ASCII/RIP screens and MUSIC clips during events
  19. and/or postcall. Special HOLIDAY screens can be rotated by specifying the
  20. appropriate information in .CFG file(s). It also has the capability of
  21. prepending .MUSic files to a file of your choice.  Even if you are NOT running
  22. a BBS, you may find a use for it. Provision was made for rotating screens based
  23. on variable date holidays or special events such as Mother's Day, which falls
  24. on a different DATE each year.
  25.  
  26.  
  27. How it does it:
  28. ==============
  29.      When executed, SWAP looks for a configuration file in the current
  30. directory (default called SWAP.CFG). The .CFG is read for information
  31. on filenames and pathnames of various lists maintained and created by
  32. you, the user. A BATch file is produced which does the work of copying
  33. files from directories to files in other directories. Terse logging is
  34. accomplished through an environment variable if desired and an
  35. alternate .CFG file may be specified on the command line.
  36.  
  37.  
  38. What it will not do:
  39. ===================
  40.      It will not PRODUCE a screen for you. Although example screens are
  41. included, it is designed for YOU to use your OWN screens.
  42.  
  43.  
  44. File listing: 
  45. ============
  46.  
  47.      The NAME of this archive should be SWAP40.ZIP or .ARJ etc. 
  48. SysOps - Please ensure this is name on YOUR BBS. Help stamp out DUPES!
  49. Suggested keywords: SWAP ROTATE ANSI/ASCII BBS/SCR RIP/MUSIC
  50.  
  51. Contents:           Purpose:
  52. ========            =======
  53. SWAP.EXE       -    Executable. You may rename it if you wish.
  54. SWAP.CFG       -    Sample Configuration file. May be renamed on a
  55.                     command line as described below. In whatever form,
  56.                     a .CFG is REQUIRED.
  57. SWAP.DOC       -    This file.
  58. SWAP.FAQ       -    Frequently asked questions about SWAP.
  59. HELLO1.LST     -    Sample listing of SCR/BBS files to swap to a
  60.                     HELLOx.xxx screen. Filename may be defined by user.
  61.                     May be deleted or renamed. Matches the files in the ZIP.
  62. GOODBYE.LST    -    Sample listing of SCR/BBS files to swap to a
  63.                     GOODBYE.xxx screen. Filename may be defined by user.
  64.                     May be deleted or renamed. Matches the files in the ZIP.
  65. HOLIDAYF.LST   -    Sample listing of SCR/BBS files to swap to a
  66.                     HELLOx.xxx screen on user specified FIXED DATE
  67.                     holidays and/or special events. Filename may be
  68.                     defined by user.
  69.                     May be deleted or renamed. Matches the files in the ZIP.
  70. HOLIDAYF.TXT   -    A listing of some of the major FIXED holidays
  71.                     throughout the world. This is NOT an all-inclusive
  72.                     listing. Use your own judgement. May be deleted.
  73. HOLIDAYV.LST   -    Sample listing of SCR/BBS files to swap to a
  74.                     HELLOx.xxx screen on user specified VARIABLE DATE
  75.                     holidays and/or special events. Filename may be
  76.                     defined by user.
  77.                     May be deleted or renamed. Matches the files in the ZIP.
  78. HOLIDAYV.TXT   -    A listing of some of the major VARIABLE DATE
  79.                     holidays throughout the world. Same notes as above.
  80. HOLIDAYV.DOC   -    Details on setting up a VARIABLE DATE holiday
  81.                     list. Separated from main documentation for readability.
  82.                     May be deleted once you understand the process.
  83. RIP.LST        -    Sample listing of RIP files to swap to HELLOx.RIP
  84.                     and/or GOODBYE.RIP for your RIP callers.
  85.                     May be deleted or renamed. Matches the files in the ZIP.
  86. MUSIC.LST      -    Listing of .MUSic files which you may want to
  87.                     prepend to a given file (ie. your DOORS.SCR file)
  88.                     which will play ANSI music when a user goes into
  89.                     the [D]oor menu.
  90.                     May be deleted or renamed. Matches the files in the ZIP.
  91. COPYIT.BAT     -    Batch file which performs the work. Filename
  92.                     defined by user. This will be created/replaced
  93.                     each time you run SWAP. May be deleted.
  94. DESC.SDI       -    File description for WILDCAT! BBSs. May be deleted.
  95. FILE_ID.DIZ    -    File description for other BBSs. May be deleted.
  96. EXAMPLES.TXT   -    File with examples and explanations. Read if you
  97.                     are still confused after reading these docs. May be
  98.                     deleted once you understand the process.
  99. MUSIC.ZIP      -    Sample music files for use with the music option.
  100.                     Matches MUSIC.LST.
  101. HELLOSCN.ZIP   -    Sample HELLO .SCR/BBS screens. Matches HELLO1.LST
  102. GDBYESCN.ZIP   -    Sample GOODBYE .SCR/BBS screens. Matches GOODBYE.LST
  103. RIPSCNS.ZIP    -    Sample HELLO and GOODBYE .RIP screens. Matches RIP.LST
  104. BBSCRHOL.ZIP   -    Sample FIXED and VARIABLE date .BBS/SCR holiday screens.
  105.                     Matches HOLIDAYF.LST and HOLIDAYV.LST
  106. RIPHOL.ZIP     -    Sample FIXED and VARIABLE date .RIP holiday screens.
  107.                     Matches HOLIDAYF.LST and HOLIDAYV.LST
  108.  
  109. Please put the contents of the ZIP files in separate directories as 
  110. recommended in these documents. Set up your config file to reflect those
  111. directories and all other items. RUN the .EXE a few times and view the
  112. batch file which is produced to ensure it meets your requirements. You
  113. may replace these sample graphics with those of your own.  The included
  114. graphics were produced by various artists.
  115.  
  116. This ZIP file was -AV stamped. If there is no indication that the file
  117. has an AV stamp as shown below, it may have been tampered with.  Get a
  118. new file.  If a "hacked" notice comes up, get a new file.
  119. # OBH709
  120. ADSUM Wildcat! BBS
  121. Note that I think putting your own advert within someone else's file is CRASS
  122. to say the least.
  123.  
  124.  
  125. Quick start
  126. ===========
  127.      To get started, all you have to do is run SWAP.EXE. You may
  128. safely do this at any time as NO CHANGES are made to ANY files
  129. whatsoever. Ensure you have a backup copy of all the files in this
  130. archive BEFORE you make any modifications. All this program does is
  131. create a .BAT file in the same directory from which SWAP.EXE is run.
  132.  
  133.  
  134. The Configuration file   (default = SWAP.CFG)
  135. ======================
  136.      The DEFAULT configuration file is "SWAP.CFG". You may change this
  137. to anything you want, but you must then use a command line as follows:
  138. SWAP MYCONFIG.TXT
  139. where MYCONFIG.TXT is your own configuration filename vice SWAP.CFG.
  140.  
  141.      Given the ability for a command line .CFG file, you can obviously
  142. have as many different configs as you wish, and can rotate many
  143. different files depending on your system. (ie. HELLO1N.xxx, HELLO1.xxx,
  144. HELLO2.xxx, ad infinitum). With judicious use of a command line config file
  145. you could even get this program to swap holiday screens to a GOODBYE.BBS
  146. screen.
  147.  
  148.      The 35 configuration items specified below MUST be syntactically
  149. correct, although they need not exist at all - in which case a BLANK
  150. LINE is required except where noted. Also, the INPUT paths, if used,
  151. MUST be terminated with a "\" or the program will record an error and
  152. halt with a prompt for you to fix the .CFG file (lines 1-12). The
  153. error will let you know which line is at fault. You may leave the
  154. COMMENTS in the file(s) as long as they are separated from the
  155. configuration items by at least ONE space as shown below.
  156.  
  157.  
  158. CONFIGURATION ITEM            COMMENT
  159. ==================            =======
  160.  
  161. C:\WILDCAT\ROTATE\HELLO\     1'INPUT Path to HELLO.BBS screen (ASCII)
  162. C:\WILDCAT\ROTATE\HELLO\     2'INPUT Path to HELLO.SCR screen (ANSI)
  163. C:\WILDCAT\ROTATE\RIP\       3'INPUT Path to HELLO.RIP screen (RIP)
  164. C:\WILDCAT\ROTATE\GOODBYE\   4'INPUT Path to GOODBYE.BBS screen (ASCII)
  165. C:\WILDCAT\ROTATE\GOODBYE\   5'INPUT Path to GOODBYE.SCR screen (ANSI)
  166. C:\WILDCAT\ROTATE\RIP\       6'INPUT Path to GOODBYE.RIP screen (RIP)
  167. C:\WILDCAT\ROTATE\HOLIDAYS\  7'INPUT Path to HOLIDAY.BBS screen (ASCII)
  168. C:\WILDCAT\ROTATE\HOLIDAYS\  8'INPUT Path to HOLIDAY.SCR screen (ANSI)
  169. C:\WILDCAT\ROTATE\RIP\       9'INPUT Path to HOLIDAY.RIP screen (RIP)
  170. C:\WILDCAT\ROTATE\HOLIDAYS\ 10'INPUT Path to HOLIDAYV.BBS screen (ASCII)
  171. C:\WILDCAT\ROTATE\HOLIDAYS\ 11'INPUT Path to HOLIDAYV.SCR screen (ANSI)
  172. C:\WILDCAT\ROTATE\RIP\      12'INPUT Path to HOLIDAYV.RIP screen (RIP)
  173. C:\WILDCAT\ROTATE\MUSIC\    13'INPUT Path to MUSIC.MUS files
  174. C:\WILDCAT\DISP\HELLO1.BBS  14'Output Path/Filename for HELLO (ASCII)
  175. C:\WILDCAT\DISP\HELLO1.SCR  15'Output Path/Filename for HELLO (ANSI)
  176. C:\WILDCAT\DISP\HELLO1.RIP  16'Output Path/Filename for HELLO (RIP)
  177. C:\WILDCAT\DISP\GOODBYE.BBS 17'Output Path/Filename for GOODBYE (ASCII)
  178. C:\WILDCAT\DISP\GOODBYE.SCR 18'Output Path/Filename for GOODBYE (ANSI)
  179. C:\WILDCAT\DISP\GOODBYE.RIP 19'Output Path/Filename for GOODBYE (RIP)
  180. C:\WILDCAT\DISP\HELLO1.BBS  20'Output Path/Filename for HOLIDAY F (ASCII)
  181. C:\WILDCAT\DISP\HELLO1.SCR  21'Output Path/Filename for HOLIDAY F (ANSI)
  182. C:\WILDCAT\DISP\HELLO1.RIP  22'Output Path/Filename for HOLIDAY F (RIP)
  183. C:\WILDCAT\DISP\HELLO1.BBS  23'Output Path/Filename for HOLIDAY V (ASCII)
  184. C:\WILDCAT\DISP\HELLO1.SCR  24'Output Path/Filename for HOLIDAY V (ANSI)
  185. C:\WILDCAT\DISP\HELLO1.RIP  25'Output Path/Filename for HOLIDAY V (RIP)
  186. C:\WILDCAT\DISP\DOORS.SCR   26'Output Path/Filename for MUSIC file
  187. HELLO1.LST                  27'List of HELLO screens (BBS/SCR)
  188. GOODBYE.LST                 28'List of GOODBYE screens (BBS/SCR)
  189. RIP.LST                     29'List of RIP files (hello,goodbye)
  190. HOLIDAYF.LST                30'List of fixed date holiday screens (BBS/SCR/RIP)
  191. HOLIDAYV.LST                31'List of variable holiday screens (BBS/SCR/RIP)
  192. MUSIC.LST                   32'List of MUSIC files
  193. DOORSSCR.BAK                33'File to PREpend .MUS to
  194. COPYIT.BAT                  34'Batch file to create.
  195. SWAP.LOG                    35'LOG file or NONE if no logging is required.
  196.  
  197.      Once you have the SWAP.CFG set up to point to the appropriate
  198. files and file areas, the next step is to create your own listings for
  199. files to rotate.
  200.  
  201.  
  202. Example HOLIDAY (FIXED) rotation list (default - HOLIDAYF.LST)
  203. =====================================
  204. DATE SCREENS                                 COMMENT
  205. ==== =======                                 =======
  206. 0101,NEWYEAR.BBS,NEWYEAR.SCR,NEWYEAR.RIP     For New Years day.
  207. 0401,APRFOOL.BBS,APRFOOL.SCR,APRFOOL.RIP     For April Fools day
  208. 0601,CDNFLAG.BBS,CDNFLAG.SCR,CDNFLAG.RIP     For Canada Day
  209. 0604,USFLAG.BBS,USFLAG.SCR,USFLAG.RIP        For US Independence Day
  210. 1224,XMASEVE.BBS,XMASEVE.SCR,XMASEVE.RIP     For Christmas Eve
  211. 1225,XMASDAY.BBS,XMASDAY.SCR,XMASDAY.RIP     For Christmas Day
  212.  
  213.      The dates (ie. 1225 above) must be in the format MMDD. This
  214. program will not work if not in this format. It does not affect the
  215. remainder of the program. Your DOS must also return the date in the
  216. standardized format of MM-DD-YYYY. You may put comments in the .LST
  217. files providing they are separated from the file listing by at least
  218. ONE space as shown above. This is handy for those who wish to NUMBER
  219. their screens. i.e. 1.BBS, 2.BBS, 3.SCR,  109A44.BBS. Note that the
  220. dates do NOT have to be in chronological order as the ENTIRE file is
  221. read and checked for a date coincident with your system date. The
  222. FIRST CORRECT DATE encountered will be used, and the program will exit.
  223.  
  224.  
  225. 0101,NEWYEAR.BBS,NEWYEAR.SCR,NEWYEAR.RIP
  226. 0401,APRFOOL.BBS,APRFOOL.SCR,APRFOOL.RIP
  227. 0601,CDNFLAG.BBS,CDNFLAG.SCR,CDNFLAG.RIP
  228. 0604,USFLAG.BBS,USFLAG.SCR,USFLAG.RIP
  229. 1224,XMASEVE.BBS,XMASEVE.SCR,XMASEVE.RIP
  230. 1225,XMASDAY.BBS,XMASDAY.SCR,XMASDAY.RIP
  231.  
  232.      The DATE and the BBS filename MUST be separated by a comma.
  233. Likewise the BBS filename and the SCR filename. If either is not used,
  234. put a comma in anyway. ie. [See example .LST files]
  235. 0101,,NEWYEAR.SCR,NEWYEAR.RIP        or 
  236. 0101,NEWYEAR.BBS,,NEWYEAR.RIP        or 
  237. 0101,,,NEWYEAR.RIP
  238.  
  239.      Those using only .BBS screens with "@" codes on a WC3.x system
  240. will find this feature handy. You may have as many holiday screens as
  241. you wish. The BBS filename and the SCR filename do not have to match, ie.
  242. 0101,NEWYEAR.BBS,PICTURE.SCR,RIPPIC.RIP
  243.  
  244.      You do not have to put dates before the files if you want to
  245. maintain a list of available files for later assignment. See the
  246. enclosed HOLIDAY.LST for examples.
  247.  
  248.      SWAP also has the capability of recognizing dates and days of the
  249. week. See the HOLIDAYV.DOC file for more information.
  250.  
  251.  
  252. Example HELLO rotation list (default = HELLO1.LST)
  253. ===========================
  254. SCREENS                       COMMENTS
  255. =======                       ========
  256. 55CHEV.BBS,55CHEV.SCR         Picture of a 55 Chevy
  257. ODIE.BBS,ODIE.SCR             Odie doing his nut
  258. YIKES!.BBS,YIKES!.SCR         Displays YIKES here comes @FIRST@
  259. WELCOME.BBS,WELCOME.SCR       ADSUM's own welcome screen
  260.  
  261.      This list has only two fields separated by a mandatory comma. The
  262. comma must be used even if you are not using both filenames, ie.
  263. 55CHEV.BBS,
  264. ,ODIE.SCR
  265.  
  266.      In the event a HELLO screen and a HOLIDAY screen have the same
  267. destination pathname AND filename, the HOLIDAY screen will be copied
  268. but the HELLO screen will not. The HOLIDAY always takes precedence and
  269. a FIXED Holiday takes precedence over the VARIABLE DATE Holiday.
  270. Hence, it is always best to either:
  271.  
  272. 1.   Make your HELLO screens as HELLO1.x and your HOLIDAY screens as 
  273.      HELLO2.x. Using this method, the program will delete the HELLO2.x
  274.      screens for each consecutive time it is run to prevent the HELLO2.x
  275.      files from showing on non-holidays.
  276. 2.   Make your HELLO screens and HOLIDAY screens as HELLO1.x. This
  277.      way, the HOLIDAY file will be overwritten, either by another
  278.      HOLIDAY screen or a standard HELLOx screen the next time it is run.
  279.      This is the best option in either case.  Too many HELLO screens make
  280.      for a boring BBS.
  281.  
  282.      The item at the TOP of the list is the NEXT screen to be copied.
  283.      Each time SWAP is run, this list is rotated to put the TOP line at the
  284.      bottom of the list. In other words, the HELLO list, after running SWAP
  285.      will now be:
  286.  
  287. ODIE.BBS,ODIE.SCR
  288. YIKES!.BBS,YIKES!.SCR
  289. WELCOME.BBS,WELCOME.SCR
  290. 55CHEV.BBS,55CHEV.SCR
  291.  
  292.  
  293.      You may have up to 365 of these files, one for each day of the
  294. year if you are so inclined. The list is rotated EVERY TIME SWAP.EXE
  295. is run.
  296.  
  297.  
  298. Example GOODBYE rotation list (default = GOODBYE.LST)
  299. =============================
  300. SCREENS                       COMMENT
  301. =======                       =======
  302. STATS.BBS,STATS.SCR           General User Stats at logoff.
  303. GOODBYE4.BBS,GOODBYE4.SCR     Picture of computer and modem
  304. GOODBYE1.BBS,GOODBYE1.SCR     Tradewar 2000 scenes
  305. GOODBYE2.BBS,GOODBYE2.SCR     User biography shown at logoff
  306.  
  307.      The GOODBYE.LST is functionally identical to the HELLO1.LST. This
  308. is designed to rotate GOODBYE.BBS/SCR screens daily.  There are NO
  309. HOLIDAY GOODBYE SCREENS, however, with judicious use of a command line
  310. configuration file, this is entirely possible to do. I will leave it
  311. to your imagination. Like the other lists, you may have COMMENTS in
  312. the .LST. However, ensure you separate the screen names from the
  313. comments by at least ONE space.
  314.  
  315.      This list has only two fields separated by a mandatory comma. The
  316. comma must be used even if you are not using both filenames, ie.
  317. STATS.BBS,
  318. ,GOODBYE2.SCR
  319.  
  320. Note that if you use the STATS.BBS as shown above, it is ASSUMED to be
  321. a file with @ codes. As such, the previous day's .SCR file will be deleted.
  322. This is will allow the STATS.BBS (@ codes) to be shown to both ANSI and
  323. ASCII callers. If you do NOT want the .SCR file to be deleted, merely put
  324. it in a 2nd time behind the STATS.BBS (ie. STATS.BBS,OTHER.SCR)
  325.  
  326. Music
  327. =====
  328.      If desired, you may have a file with music placed at the front of it.
  329. Several .MUS files are included. These are not my files, but were part of
  330. another public domain package. I include them here for completeness. 
  331.  
  332.      My DOORS.SCR file is the target file. Initially, this entails
  333. copying your DOORS.SCR to your \ROTATE directory (or where SWAP.EXE
  334. resides) and renaming it to any other filename. I use the filename of
  335. DOORSSCR.MUS - let's call this the "dummy" file.
  336.  
  337.      When SWAP runs, it reads the MUSIC.LST to get the filename in the top
  338. position. The appropriate .MUS file is then copied along with DOORSSCR.MUS to a
  339. temporary file called MUSIC.MUS. Note that MUSIC.MUS is merely DOORSSCR.MUS
  340. (DOORS.SCR) with ANSI music as a header. DOORS.SCR is not modified directly.
  341.  
  342.      MUSIC.MUS is then copied to the path and filename you specified in
  343. SWAP.CFG (on my system, it is copied to C:\WC30\DISP\DOORS.SCR). Because
  344. MUSIC.MUS is no longer required, it is deleted to keep the system "clean". Now,
  345. whenever someone goes into the [D]oor menu, and IF they have a terminal program
  346. capable of hearing ANSI music (ie. QModemPro) and IF they have their colour
  347. turned on -- they will hear the selected "tune of the day".
  348.  
  349.      You might note that DOORSSCR.MUS is not altered in any way. This is in
  350. case you wish to restore DOORS.SCR without music. It is, in fact, a backup.
  351.  
  352.  
  353. RIP Screens.
  354. ===========
  355.  
  356.      This program has a provision to rotate RIP screens. As more and more of
  357. these screens are available, you might want to take advantage of them by
  358. providing them for your RIP users. The syntax of the RIP.LST file is similar to
  359. the HELLO/GOODBYE lists, except the HELLO.RIP and GOODBYE.RIP are combined. ie.
  360.  
  361. HELLO1.RIP,GOODBYE1.RIP            hello is 1st, goodbye 2nd.
  362. ,GOODBYE2.RIP                      hello not replaced, goodbye rotated
  363. HELLO2.RIP,                        hello rotated, goodbye not replaced
  364. WILDCAT2.RIP,LOGCABIN.RIP          hello is Wildcat2, goodbye is Logcabin
  365.  
  366.  
  367. LOG FILE
  368. ========
  369.  
  370. IN THE CONFIGURATION FILE (LINE 35)
  371. =========================
  372.      Line 35 specifies the full path and filename of a LOG file of
  373. your choosing.  Optionally, you may put "NONE" on this line, ie:
  374.  
  375. NONE                        No log file specified in the CFG.
  376. ..or..
  377. C:\WILDCAT\ACTIVITY.1       Terse log to Activity.1 file.
  378.  
  379.      This is a TERSE log, opened in the append mode with file locking
  380. in case you wish to log to activity logs or other files which may be
  381. used by other programs on a multitasking system. Since it only takes a
  382. second to write the information, this should not pose a problem anyway.
  383.  
  384.  
  385. Via an ENVIRONMENT VARIABLE: (SET SWAPLOG=)
  386. ===========================
  387.  
  388.      If you wish to log to a file using an environment variable:
  389. "SET SWAPLOG=" and then the FULL PATH AND FILENAME FOR THE LOG. ie.
  390. SET SWAPLOG=C:\WC30\ACTIVITY.3
  391.       ...or...
  392. SET SWAPLOG=D:\SYSTEM\SWAPLOG.LOG
  393.  
  394.      Try it from the DOS prompt. If you get an "out of environment space"
  395. error, you may have to temporarily remove something from your environment and
  396. put it back again.  This can easily be accomplished from within the batch file
  397. which calls SWAP.
  398.  
  399.      For example, I have a "SET QMPRO=C:\QMPRO". A batch file to temporarily
  400. remove/reinstall it might look like:
  401. @ECHO OFF                             Not necessary
  402. SET QMPRO=                            removes QMODEM from the environment
  403. SET SWAPLOG=C:\WILDCAT\ACTIVITY.3     puts swaplog into the environment
  404. SWAP                                  executes SWAP.EXE
  405. CALL COPYIT BAT                       copies the files
  406. SET SWAPLOG=                          removes swaplog from environment
  407. SET QMPRO=C:\QMPRO                    reinstalls QMODEM to environment
  408. NODE2                                 runs batch for the BBS (if necessary)
  409.  
  410.      Note: You may have a log specified in the .CFG file and at the
  411. same time, have one specified in the ENVIRONMENT. However, the
  412. ENVIRONMENT log will take precedence and the .CFG log will be ignored.
  413.  
  414.  
  415. Suggested setup
  416. ===============
  417. The "standard" setup is to have a subdirectory hanging off your Wildcat! home
  418. directory (normally C:\WILDCAT). Lets assume you name this directory ROTATE
  419. (C:\WILDCAT\ROTATE). Put SWAP.EXE, SWAP.CFG, MUSIC.LST, HOLIDAYF.LST,
  420. HOLIDAYV.LST, HELLO1.LST, GOODBYE.LST, RIP.LST (or your specified .LSTs and
  421. .CFGs) in this directory. COPYIT.BAT (or your specified filename) will be
  422. created in this directory when SWAP.EXE is run successfully.
  423.  
  424. Put all HOLIDAY (.BBS/.SCR/.RIP) screens in a subdir of the ROTATE directory 
  425. (ie. C:\WILDCAT\ROTATE\HOLIDAY). 
  426.  
  427. Put the HELLO screens in a subdirectory of the ROTATE directory 
  428. (ie. C:\WILDCAT\ROTATE\HELLO).
  429.  
  430. Put the GOODBYE screens in a subdirectory of the ROTATE directory 
  431. (ie. C:\WILDCAT\ROTATE\GOODBYE).
  432.  
  433. Put the RIP hello/goodbye screens in a subdirectory of the ROTATE directory:
  434. (ie. C:\WILDCAT\ROTATE\RIP)
  435.  
  436. Put the .MUS files into a subdirectory of the ROTATE directory
  437. (ie. C:\WILDCAT\ROTATE\MUSIC).
  438.  
  439. Note:     The above is NOT necessary. You may have them anywhere you want as
  440. long as you point the .CFG to the proper directory for the files. You may even
  441. have them in the \ROTATE directory if you wish. However, this will make it
  442. quite cluttered if you have a lot of display files. Also, the INPUT paths to
  443. files may be eliminated from the .CFG file if they are in the same directory as
  444. the SWAP.EXE file - and provided you leave a blank line in the .CFG file. You
  445. can make it simple or make it hard ... your choice.
  446.  
  447.  
  448. Event or Postcall BATCH file
  449. ============================
  450.      When SWAP is run, it creates a batch file based on your configuration. 
  451. The batch file will magically appear in the same directory as SWAP.EXE. 
  452. Default batch file is COPYIT.BAT.
  453.  
  454.      Your EVENT.BAT must then CALL COPYIT.BAT file.
  455. Again, you could even use it in a POSTCALL.BAT file to rotate screens
  456. between calls although this would be highly redundant.
  457.  
  458. An example of an EVENT batch file to accomplish this is might be:
  459.  
  460. @ECHO OFF              Not necessary
  461. WCPRO NEWUSERS         Run a Wildcat! PRO utility
  462. FLOP                   Run Michael Conley's FLOP program
  463. CD C:\WILDCAT\ROTATE   Change to ROTATE DIRECTORY (where SWAP.EXE lives)
  464. ECHO:
  465. SET SWAPLOG=C:\WILDCAT\ACTIVITY.1   Log details to a file
  466. SWAP                   Execute SWAP
  467. SET SWAPLOG=           Remove swaplog from environment
  468. CALL COPYIT.BAT        Execute the BAT file to copy the .BBS/.SCR files
  469. ECHO:
  470. CD C:\WILDCAT          Go back to WC Home directory
  471. WCPRO NEWFILES         Run a Wildcat! PRO utility
  472. NODE1                  Return to Wildcat. This line is required only if
  473.                        a. your batch file to run wildcat is NODE1.BAT; AND
  474.                        b. you are terminating for events (vice shelling).
  475.  
  476.      Using the supplied SWAP.CFG program, the BATch file might be as
  477. shown below. This is a sample only. You can run the SWAP.EXE program
  478. AT ANY TIME to produce your own batch file based on your configuration.
  479. This is ideal for testing your setup.
  480.  
  481. COPY BLAST.MUS + DOORSSCR.MUS MUSIC.MUS
  482. COPY MUSIC.MUS C:\WC30\DISP\DOORS.SCR
  483. DEL MUSIC.MUS
  484. COPY C:\WILDCAT\ROTATE\GOODBYE\GOODBYE2.BBS C:\WC30\DISP\GOODBYE.BBS
  485. COPY C:\WILDCAT\ROTATE\GOODBYE\GOODBYE2.SCR C:\WC30\DISP\GOODBYE.SCR
  486. COPY C:\WILDCAT\ROTATE\HOLIDAYS\LABOUR.BBS C:\WC30\DISP\HELLO1.BBS
  487. COPY C:\WILDCAT\ROTATE\HOLIDAYS\LABOUR.SCR C:\WC30\DISP\HELLO1.SCR
  488. COPY C:\WILDCAT\ROTATE\RIP\WILDCAT.RIP C:\WC30\DISP\HELLO1.RIP
  489. COPY C:\WILDCAT\ROTATE\RIP\SOLONG.RIP C:\WC30\DISP\GOODBYE.RIP
  490.  
  491. Note the hierarchy. 
  492.      The GOODBYE screens are copied first. The HELLO1 screens are then
  493. copied provided there is not a holiday AND the path/filenames are the
  494. same. In the example above, there *IS* a holiday. Therefore the HELLO1
  495. files will not be copied because on my system, they are directed to
  496. the same output path/filename as the HOLIDAY screens. Note also that the
  497. holiday list did NOT contain a .RIP file. Hence, the NORMAL hello .RIP
  498. file is used.
  499.  
  500.      As an added note here; if there happens to be a VARIABLE HOLIDAY
  501. falling on the SAME DAY as a FIXED HOLIDAY, the FIXED HOLIDAY screen
  502. will be rotated UNLESS the VARIABLE HOLIDAY and the FIXED HOLIDAY
  503. output paths are different. 
  504.  
  505.      A reminder that if the HOLIDAYs are going to a DIFFERENT filename
  506. than the HELLO files, they will both be produced. Also, don't forget,
  507. if you are using DIFFERENT filenames for the HOLIDAY screens (i.e.
  508. HELLO2.BBS) then the program will DELETE the destination holiday files
  509. (ie. HELLO2.x) EACH EVENING to ensure they are not carried over to the
  510. next day.
  511.  
  512.  
  513.                                 ┌────────────┐
  514.                                 │Almost done!│
  515.                                 └────────────┘
  516. Just one more example. 
  517.  
  518. Here is an example of a nightly EVENT batch file with a command line
  519. specified configuration file:
  520.  
  521. @ECHO OFF
  522. WCPRO NEWUSERS
  523. FLOP
  524. CD C:\WILDCAT\ROTATE
  525. ECHO:
  526. SET SWAPLOG=D:\SWAP.LOG
  527. SWAP 1STNAME.CFG    Swap executed with specific items in 1STMAME.CFG
  528. CALL MY1STBAT.BAT   Call the batch file (instead of COPYIT.BAT)
  529. SWAP 2NDNAME.CFG    Swap executed with specific items in 2NDNAME.CFG
  530. CALL MY2NDBAT.BAT   Call another batch file (instead of COPYIT.BAT)
  531. SWAP                Swap executed with default .CFG (SWAP.CFG)
  532. SET SWAPLOG=
  533. CALL COPYIT.BAT     Call the default batch file
  534. ECHO:
  535. CD C:\WILDCAT
  536. WCPRO NEWFILES 
  537.  
  538. (Note:    the .BAT files above are specified in the different .CFG
  539.           files as explained earlier)
  540.  
  541.      If you are still confused, see the file called EXAMPLES.TXT for
  542. further examples of .CFG, .LST and other files.
  543.  
  544.  
  545. Support:
  546. =======
  547.      If you have a suggestion, feel free to drop me a message in MSI's 
  548. "3rd Party" conference or on Wildnet/Compulink in an appropriate conference.
  549. If you have a question, please ensure you have read this wordy documentation
  550. carefully and noted all the hazard areas (ie. no comma delimiters, missing
  551. lines in .CFG files, etc). If you are convinced you cannot solve the problem,
  552. ZIP me your .LST files and .CFG file and a[t]tach it to a message for me. I
  553. will have a look at the files and get back to you. If you intend using VARIABLE
  554. HOLIDAY lists, then PLEASE PLEASE PLEASE read the HOLIDAYV.DOC file CAREFULLY. 
  555. I can't stress this enough.
  556.  
  557.  
  558. ERRORS
  559. ======
  560.  
  561. 1.   Non-fatal errors and other comments, such as no HELLO.LST file
  562.      (blank line instead), are logged directly to the BATCH file. Read
  563.      the BATCH file after you have run the program to get an idea of
  564.      what I am talking about.
  565.  
  566. 2.   The SWAP.EXE program will HALT if there is:
  567.      a.   an INVALID filename specified for the .LST files (you need
  568.           not have a .LST file, but you must have a blank line
  569.           instead)
  570.      b.   an INVALID or NO batch file specified, or SWAP can't find it
  571.           in the directory from which SWAP was run.
  572.      c.   an Illegal DOS filename for the .LST or .BAT file.
  573.  
  574.      This allows debugging a .CFG file BEFORE installation. If you
  575. don't get anything else right -- make sure you set up the config
  576. file(s) properly.
  577.  
  578.  
  579. Beg for $$$
  580. ===========
  581. This program _will_ run as defined in the documents. I have been running it 
  582. on my own BBS for quite a number of months. I make no claim that this program
  583. is the "ultimate" or the "best" as so many egoistic authors are prone to 
  584. claim, nor is there any indication of who wrote the program visible to your
  585. callers as so many egomaniacs feel the necessity to do. It is not crippled
  586. in any way and no "delays" will be encountered while the author begs for $$$.
  587. This program, as in all others I have written and put out as shareware, is 
  588. fully functional.  If you find this program useful, I would appreciate (who
  589. wouldn't) a donation of a Ten dollars and 32 cents ($10.32) in ANY currency.
  590.  
  591. Other Programs by the author:
  592. ============================
  593. SWAP      -    A program to swap .BBS, .SCR, .RIP HELLO/GOODBYE files on a 
  594.                daily basis, with swapping of specifically named files on 
  595.                holidays. Also, it will prepend any .MUS(ic) file to a file 
  596.                you specify (i.e. DOORS.SCR) so that when someone enters the 
  597.                DOOR menu, music will play on the remote console if the user's
  598.                terminal program is capable.
  599. POSTSWAP  -    Frame rotator for Wildcat BBSs. Provide variety to your RIP
  600.                users.  Rotates YOUR frame to replace POSTRIP.RIP on a daily
  601.                (or more often) basis. Sample frames included.
  602. COPYRIP   -    Companion to POSTSWAP designed such that after POSTSWAP is
  603.                run, the COPYRIP will then copy specified .BBS files along
  604.                with the *NEW* POSTRIP.RIP file so that files such as
  605.                HELLO1.BBS will have a RIP header and will scroll properly
  606.                to your RIP users.
  607. CONSTATS  -    Produces a text file after reading ACTIVITY.x files to give
  608.                a breakdown of connection types (ANSI/ASCII/RIP) along with
  609.                number using MNP and a breakdown of all connect speeds from
  610.                300-28.8k along with whether V.34 or V.FC.
  611. PALOG     -    Logs batch activity to a file you specify. Supports multi-
  612.                node and WCNODEID= environment variable. Designed for a
  613.                Wildcat! BBS but will work on any BBS. In fact, it can be
  614.                used anywhere batch files are used.
  615. Enjoy....
  616.  
  617. The author may be contacted at:
  618.  
  619. Terry Atkinson
  620. 28 Savona Court
  621. Dartmouth, NS Canada
  622. B2W 4R1
  623.  
  624. Charlatan's Cabin BBS
  625. MSI HQ BBS
  626. nstn1175@fox.nstn.ca
  627. Terry.Atkinson@cabin.com
  628. 75376.1277@compuserve.com
  629.    or the author's BBS -
  630. Adsum Wildcat! BBS
  631. Node 1: 902-434-3121
  632. Node 2: 902-435-2455
  633. Node 3: 902-434-2350 (Donor line only)
  634.  
  635. Users must be VERIFIED to gain full access, including messages and files.
  636. You may leave a message as a COMMENT only, and you may look at the files
  637. but you cannot download or upload.
  638.  
  639. ****NOTE****
  640.  
  641. SysOps: Help stamp out duplicates. The proper filename for this file is
  642. SWAP40.xxx (where xxx = ZIP ARJ LZH or other compression identifier).
  643.  
  644. Short Description:
  645. SWAP v4.0: 6/95. Versatile screen swapper for Wildcat! BBSs
  646.  
  647. Long Description:
  648. SWAP v4.0: 6/95. Screen swapper for Wildcat!
  649. or --for any BBS needing different display
  650. screens for every day. Designed for Wildcat!,
  651. SWAP is highly configurable. It runs from 
  652. a default CFG filename or you may specify your
  653. own on a command line. SWAP creates a batch 
  654. file which actually does the rotation of 
  655. screens. This allows running the program many
  656. times for CFG debugging. Probably the only screen
  657. swapper you will ever need. Swaps ASCII, ANSI,
  658. .MUSic, RIP. You name it.
  659.  
  660. Keywords:
  661. ROTATE SWAP HOLIDAYS SCRBBSRIP HELLO GOODBYE
  662.  
  663.  
  664. LIMITED WARRANTY
  665. ================
  666. THIS SOFTWARE AND DOCUMENTS ARE PROVIDED FOR EVALUATION ONLY, ON AN 
  667. "AS IS" BASIS.  TERRY ATKINSON AND/OR ADSUM BBS DISCLAIM(S) ALL WARRANTIES 
  668. RELATING TO THIS SOFTWARE, WHETHER EXPRESSED OR IMPLIED, INCLUDING BUT 
  669. NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR
  670. A PARTICULAR PURPOSE. NEITHER TERRY ATKINSON NOR ANYONE ELSE WHO HAS BEEN
  671. INVOLVED IN THE CREATION, PRODUCTION, OR DELIVERY OF THIS SOFTWARE WILL
  672. BE LIABLE FOR ANY INDIRECT, CONSEQUENTIAL, OR INCIDENTAL DAMAGES ARISING 
  673. OUT OF THE USE OR INABILITY TO USE SUCH SOFTWARE, EVEN IF THE AUTHOR HAS
  674. BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES OR CLAIMS.  THE INDIVIDUAL 
  675. USING THE SOFTWARE BEARS ALL RISK AS TO THE QUALITY AND PERFORMANCE OF 
  676. THE SOFTWARE.
  677.  
  678. TRIAL USE LICENCE
  679. =================
  680. This is NOT a public domain program.  It is copyrighted by Terry
  681. Atkinson and distributed under the shareware concept.  This software 
  682. and accompanying documentation are protected by copyright laws of 
  683. various countries and international treaty provisions.
  684.  
  685. You are granted a limited license to use this software for evaluation 
  686. purposes for a period not to exceed sixty days.  If you continue using 
  687. this software after the sixty-day evaluation period, you MUST make a 
  688. registration payment as described in the documents submitted to the 
  689. address specified in the documents.
  690.  
  691. You may not use, copy, rent, lease, sell, modify, decompile,
  692. disassemble, otherwise reverse engineer, or transfer the licensed
  693. program except as provided in this agreement.  All rights not 
  694. expressly granted here are reserved to Terry Atkinson.
  695.  
  696.  
  697. DISTRIBUTION
  698. ============
  699. You may make this file available for downloading from your BBS or you may
  700. upload it to any BBS of your choice, provided that you do not make any
  701. changes to the contents of the archive (ZIP file). The archive and its
  702. individual contents may not be used by any service that charges any money
  703. whatsoever, without the written permission of the author.
  704.  
  705.  
  706. SHAREWARE: Describes a marketing method in which copyright programs 
  707. circulate among users for purposes of evaluation. This gives you the option 
  708. to "Try Before You Buy". Using this system, the author of a program typically 
  709. allows you to try the program for a specified period before payment is 
  710. required. The exact terms of evaluation vary from author to author, so be 
  711. sure to check the documentation of the programs you evaluate.
  712.  
  713. Any fee you pay to a disk vendor is simply a distribution fee, and does
  714. not cover the cost of the program itself. Programs which are used beyond
  715. the author's prescribed evaluation period require separate payment to the
  716. author. By making payment to the author you obtain a legal right to use the
  717. software, and encourage the continued development of quality software
  718. within the Shareware system.
  719.  
  720. The process of paying for the software is called "registration". The
  721. exact benefits of registration vary from author to author, but many authors
  722. will offer one or more of the following: a current version, technical
  723. support, a printed manual, free or discounted upgrades, bonus utilities or
  724. special offers. More often than not, registration is for your peace of mind.
  725. Consult the registration information included with each program for specific 
  726. details.
  727.