home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / FEST2.ZIP / FESTIVTY.DOC < prev    next >
Encoding:
Text File  |  1994-06-10  |  20.0 KB  |  373 lines

  1. ┌─────────────────────────────────────────────────────────────────────────────┐
  2. │                       ▄▄▄         ▄             ▄                           │
  3. │                     ▄▀   ▀        █             █                           │
  4. │                     █             █▄▄ ▄       ▄ █▄▄                         │
  5. │                     █▄▄  ▄▄▄  ▄▄▄ █   ▄ ▄   ▄ ▄ █   ▄  ▄                    │
  6. │                     █   █▄▄▄ ▀▄▄▄ █   █ █   █ █ █   █  █                    │
  7. │                     █   █▄▄▄ ▄▄▄█ █   █  ▀▄▀  █ █   ▀▄▄█                    │
  8. │                                                        █                    │
  9. │                                 Version 2.0            █                    │
  10. │                                                   ▀▄▄▄▀                     │
  11. │                         2nd Generation of CC-Holiday                        │
  12. │                                                                             │
  13. │                         Automated Holiday and Events                        │
  14. │                          Message Maker For The BBS                          │
  15. │                                                                             │
  16. │                                                                             │
  17. │                                  Created by                                 │
  18. │                          David Tym, Copyright 1994                          │
  19. │                                                                             │
  20. │                             In Association with                             │
  21. │                Xcelled Tek-Nologies & CyCom Quality Programs                │
  22. └─────────────────────────────────────────────────────────────────────────────┘
  23.  Made In Canada
  24.  
  25. ┌─────────────────────────────────────────────────────────────────────────────┐
  26. │                              Table of Contents                              │
  27. │ Section Name                                                           Area │
  28. └─────────────────────────────────────────────────────────────────────────────┘
  29.  * = What you must read
  30.  
  31.   What is Festivity? ...................................................... 1
  32.        What if your not a SysOp?  ......................................... 1a
  33.   Warranty and disclaimer ................................................. 2
  34.   Using Festivity (SetUp) ................................................. 3
  35.      * Real quick installation ............................................ 3a
  36.        Detailed installation .............................................. 3b
  37.             ANSI, ASCII, and RIP; what's that?  ........................... 3c
  38.             What if I don't support ANSI, ASCII, or RIP? .................. 3d
  39.   Festivity necessary files ............................................... 4
  40.   Registration information ................................................ 5
  41.   Credits ................................................................. 6
  42.   Support sites ........................................................... 7
  43.   Help! I'm stuck (Trouble Shooting) ...................................... 8
  44.   What's new .............................................................. 9
  45.  
  46. ┌─────────────────────────────────────────────────────────────────────────────┐
  47. │ What is Festivity?                                                        1 │
  48. └─────────────────────────────────────────────────────────────────────────────┘
  49.  
  50.  Festivity, simply put, is an automated holiday or event message maker for the
  51.  Electronic Bulletin Board System.  It is geared to make the life of the SysOp
  52.  easier so he/she can perform other, more important functions towards the BBS.
  53.  
  54.  This program will generate attractive ANSI, ASCII, and RIP style screens, and
  55.  output them in the form of bulletins; or what ever you want!  As well you can
  56.  tell Festivity the path and names of your ANSI, ASCII and RIP screens,
  57.  allowing for total flexibility!
  58.  
  59.  Screens will be generated during holidays such as Labour Day, Thanksgiving,
  60.  Christmas Day, New Years Day, etc... once this program is set up.  Festivity
  61.  it is completely self powered, so the SysOp doesn't have to check up on it
  62.  constantly.  Basically this program will generate holiday bulletins, and the
  63.  SysOp doesn't even have to lift a finger.  Until the year 2020 that is.  This
  64.  version of Festivity will continue to make bulletins until January 1st 2020.
  65.  
  66.                  - CC-Holiday is the predecessor to Festivity -
  67.  
  68. ┌───────────────────────────────────┐
  69. │ What if your not a SysOp       1a │
  70. └───────────────────────────────────┘
  71.  
  72.  Festivity does not require a BBS to run.  If you want to use it out of the BBS
  73.  environment you can.  Just follow the instructions, in section 3 on how to set
  74.  up the program.  The only difference is you will not be using any BBS style
  75.  events.
  76.  
  77. ┌─────────────────────────────────────────────────────────────────────────────┐
  78. │ Warranty and Disclaimer                                                   2 │
  79. └─────────────────────────────────────────────────────────────────────────────┘
  80.  
  81.       This product is provided "as is" without a warranty of any kind.  The
  82.  entire risk as to the results and performance of this program is assumed by
  83.  you.  The authors and any other people mentioned do not warrant, guarantee, or
  84.  make any representations regarding the use of, or the results of the use of
  85.  the program, and you rely on the program and results solely at your own risk.
  86.  The authors or others mentioned can not accept responsibility for system
  87.  damage, either directly or indirectly from the use of this product.
  88.  
  89.       The authors and any other people mentioned are in no way responsible for
  90.  any damages sustained either directly or indirectly from the use of Festivity.
  91.  Also if the file has been modified in any way the author or anyone else
  92.  mentioned will take no responsibility for it.  The .EXE file(s) and all other
  93.  files have been tested on several machines, from XT's to 486's and have worked
  94.  perfectly on all. If you should have any problems with this file please see
  95.  sections 7 and 8 in this manual.
  96.  
  97.                            - Vandalism is not wanted -
  98.  
  99.   You may not edit, or change this program, graphics, or documentation in any
  100.          way, shape or form without written permission from David Tym.
  101.                  Failure to do so, will result in prosecution.
  102.  
  103. ┌─────────────────────────────────────────────────────────────────────────────┐
  104. │ Using Festivity (SetUp)                                                   3 │
  105. └─────────────────────────────────────────────────────────────────────────────┘
  106.  
  107.  The set up of Festivity is fairly simple and should take no more than 5
  108.  minuets (Famous last words eh?).
  109.  
  110. ┌───────────────────────────────────┐
  111. │ Real Quick Installation        3a │
  112. └───────────────────────────────────┘
  113.  
  114.   1.  Put all Festivity files into a directory.  The directory can be anything.
  115.       Example = C:\FEST
  116.  
  117.   2.  Run FESTCFG.EXE (a simple to understand setup program).
  118.  
  119.   3.  Edit your BBS so that it runs FEST.EXE as an event EACH DAY.
  120.  
  121.  That's it for the quick installation.  If you find that you are having
  122.  problems, or the above does not explain enough, see section 3b, Detailed
  123.  Installation.
  124.  
  125. ┌───────────────────────────────────┐
  126. │ Detailed Installation          3b │
  127. └───────────────────────────────────┘
  128.  
  129.  Simply put all Festivity files into its own directory.  Perhaps you want to
  130.  put it in your route (C:\FEST) or perhaps somewhere close to your display
  131.  files (C:\BBS\DISPLAY\FEST).  The point is it does not matter where you put
  132.  Festivity; it can even go in with your display files.
  133.  
  134.  Once you have found a spot for it run FESTCFG.EXE.  This is a simple easy to
  135.  understand program that sets up a configuration file needed by FEST.EXE.  When
  136.  you run this program you will see a menu much like this...
  137.  
  138. ┌─────────────────────────────────────────────────────────────────────────────┐
  139. │ Enter path/name for the ANSI file  : C:\BBS\FILES\FESTVT.ANS                │
  140. │ Enter path/name for the ASCII file : C:\BBS\FILES\FESTVT.ASC                │
  141. │ Enter path/name for the RIP file   : C:\BBS\FILES\FESTVT.RIP                │
  142. │ Clear Screen before displaying file? Y                                      │
  143. │ Registration Code                  : 0                                      │
  144. │ Your full real name                : Your Name                              │
  145. │                                                                             │
  146. │                                                                             │
  147. │                                                                             │
  148. └─────────────────────────────────────────────────────────────────────────────┘
  149.  
  150.  The first line will be hi-lighted and you will type in the path and name of
  151.  the ANSI file (The example C:\BBS\FILES\FESTVT.ANS is provided).  After
  152.  pressing ENTER, the hi-lighted bar will move to the next line.  Enter the path
  153.  and file name to your ASCII file (don't have to include a path, can just be a
  154.  file name).  Finally enter the path and file name to your ANSI and RIP files
  155.  (See section 3c and 3d if you do not support ANSI, ASCII, or RIP files).
  156.  
  157.  Next you are asked if you would like screen clearing.  YES will clear the
  158.  screen before the holiday or event bulletin is displayed.  NO will not clear
  159.  the screen before the bulletin is displayed.
  160.  
  161.  Now that you have entered Y or N for screen clearing you move onto the
  162.  registering option.  This is where you put the registration code if you
  163.  register this fine piece of software (See section 5 for more information on
  164.  registering).
  165.  
  166.  Last but not least is typing in your FULL name.  It is case sensitive, so what
  167.  you type is what you get.  It does not matter if this program is registered or
  168.  not, please type your name.
  169.  
  170.  Once you save your changes, Festivity is configured for your system (That
  171.  wasn't so bad, was it).
  172.  
  173.  Now for the crazy part!  You have to make Festivity run as a daily event.
  174.  If this is your first time making an event, then your probably going to scream
  175.  at me for this next line.  Refer to your BBS documentation for more
  176.  information on creating events.  Unfortunately because every BBS system is
  177.  different, I can't put descriptions of how all BBS events are set up.
  178.  However, I will give you a short example of how SpitFire events look.
  179.  
  180.  For SpitFire systems, edit your SF.BAT file to look something like this:
  181.  
  182.  Event_A
  183.  REM Event for Festivity
  184.  CD\SF\DISPLAY\FEST                        'Path to Festivity
  185.  FEST.EXE                                  'Execute Festivity
  186.  CD\SF                                     'Return to SF directory
  187.  GOTO LOOP:
  188.  
  189.  Chances are, if your BBS uses BAT files to run events, then yours will look
  190.  something like this.  That's it for the set up!
  191.  
  192. ┌───────────────────────────────────┐
  193. │ ANSI, ASCII, RIP, What's That? 3c │
  194. └───────────────────────────────────┘
  195.  
  196.  ASCII - Files that contain text.  Almost all computers support ASCII as it is
  197.          the American Standard Code Of Information Interchange.  This document
  198.          is an ASCII file.
  199.  
  200.  ANSI - Similar to ASCII, with the exception that ANSI has certain codes that
  201.         allow for colour, centering of text, screen clearing, etc.
  202.  
  203.  RIP - Also similar to ASCII and ANSI, RIP files (short for Remote Imaging
  204.        Protocol) are 16 colour VGA text files.
  205.  
  206. ┌───────────────────────────────────┐
  207. │ I Don't Support RIP, etc...    3d │
  208. └───────────────────────────────────┘
  209.  
  210.  If you can't support RIP or one of the other file formats, then simply leave a
  211.  blank space where FESTCFG.EXE asks for your path and file name.
  212.  
  213. ┌─────────────────────────────────────────────────────────────────────────────┐
  214. │ Festivity Necessary Files                                                 4 │
  215. └─────────────────────────────────────────────────────────────────────────────┘
  216.  
  217.  FEST.EXE     -> The main excitable file (Run this as an event)
  218.  FESTCFG.EXE  -> The set up program      (Run this to set up FEST.EXE)
  219.  FESTIVTY.DOC -> This documentation      (Read this and be enlightened)
  220.  
  221. ┌─────────────────────────────────────────────────────────────────────────────┐
  222. │ Registration Information                                                  5 │
  223. └─────────────────────────────────────────────────────────────────────────────┘
  224.  If you plan on registering you will receive the following:
  225.  
  226.  - A registration code by mail
  227.  - The annoying reminder will no longer be present, as well as the loud beep
  228.    during the event.
  229.  
  230.  It is recommended that you pay by check or money order.  Cash is sometimes
  231.  lost by our glorious mail system.  I can not be responsible if I do not revive
  232.  the necessary funds for this product.  To register this version of Festivity
  233.  please send seven Canadian dollars ($7) to the address stated below.
  234.  
  235.                    - Please allow 3 to 4 weeks for delivery -
  236.  
  237.  Please fill out the following form and mail it to:
  238.  
  239.                                    David Tym
  240.                               1144 Maidstone Cres.
  241.                                Oakville, Ontario
  242.                                      Canada
  243.                                     L6M-1C3
  244.  
  245. ------------------------------------- cut -------------------------------------
  246.  
  247. ┌─────────────────────────────────────────────────────────────────────────────┐
  248. │                                  Festivity                                  │
  249. │                                 Version 2.0                                 │
  250. │                                                                             │
  251. │                                                                             │
  252. │ Legal Name: ______________________________________________________________  │
  253. │                                                                             │
  254. │ Address: _________________________________________________________________  │
  255. │                                                                             │
  256. │ City/Province: __________________________________ Postal Code: ___________  │
  257. │                                                                             │
  258. │ Voice Phone Number, With Area Code: _____________________                   │
  259. │                                                                             │
  260. │ BBS Name: ________________________________________________________________  │
  261. │                                                                             │
  262. │ BBS Phone Number: ______________________                                    │
  263. │                                                                             │
  264. │ You have enclosed a registration fee of: ________________________ dollars.  │
  265. │                                                                             │
  266. │ Comments: ________________________________________________________________  │
  267. │                                                                             │
  268. │ __________________________________________________________________________  │
  269. │                                                                             │
  270. │ __________________________________________________________________________  │
  271. │                                                                             │
  272. ├─────────────────────────────────────────────────────────────────────────────┤
  273. │    S                             David Tym                                  │
  274. │    E  T                     1144 Maidstone Cres.                            │
  275. │    N  O                      Oakville, Ontario                              │
  276. │    D                               Canada                                   │
  277. │                                   L6M-1C3                                   │
  278. ├─────────────────────────────────────────────────────────────────────────────┤
  279. │                          Thank you for registering                          │
  280. └─────────────────────────────────────────────────────────────────────────────┘
  281.  
  282. ------------------------------------- cut -------------------------------------
  283.  
  284. ┌─────────────────────────────────────────────────────────────────────────────┐
  285. │ Credits                                                                   6 │
  286. └─────────────────────────────────────────────────────────────────────────────┘
  287.  
  288.  Festivity, its initial concept, programming, graphics and documentation were
  289.  produced by David Tym.
  290.  
  291.  Festivity would not have taken on its new look without the helpful advice of
  292.  Simon Shelson.
  293.  
  294. ┌─────────────────────────────────────────────────────────────────────────────┐
  295. │ Support Sites                                                             7 │
  296. └─────────────────────────────────────────────────────────────────────────────┘
  297.  
  298.                                - Components BBS -
  299.                                  (905)827-6284
  300.                                   Oakville, ON
  301.                                      Canada
  302.  
  303.                        We can also be reached by mail at
  304.  
  305.                               1144 Maidstone Cres.
  306.                                Oakville, Ontario
  307.                                      Canada
  308.                                     L6M-1C3
  309.  
  310.  If you have telepathic abilities, I can be reached on a higher Psychic plain.
  311.  
  312. ┌─────────────────────────────────────────────────────────────────────────────┐
  313. │ Help!  I'm Stuck!                                                         8 │
  314. └─────────────────────────────────────────────────────────────────────────────┘
  315.  
  316.  Q: Why do I get an "Error 1 - ...." message?
  317.  A: You haven't run FESTCFG.EXE, or you incorrectly set up the program.
  318.     A file named ERRORS.DAT was created, please refer to that.
  319.  
  320.  Q: Why doesn't the ANSI, ASCII, & RIP screens show up on my BBS, even after
  321.     they have been made and are sitting in my display directory?
  322.  A: Make sure the graphic file names and directories are correct.  Run
  323.     FESTCFG.EXE to change the graphic file names.  Your BBS software must be
  324.     able to recognize the name you enter.  For SpitFire systems, it is
  325.     recommend that ALL.BBS for the ASCII file, ALL.CLR for the ANSI file
  326.     and ALL.RIP for the RIP file are used.
  327.  
  328.  Q: Why doesn't the RIP screen show up on my BBS?
  329.  A: Make sure your BBS software support RIP graphics.  If it does, run
  330.     FESTCFG.EXE and make sure you have entered in the correct directory and
  331.     file name.
  332.  
  333.  Q: Why should I register this program?
  334.  A: So you can raise your CyCom programers self esteem, as well as ensure the
  335.     continual development of products like this.
  336.  
  337.  Q: It wont run as an event!
  338.  A: Check your BBS's documentation on correctly setting up programs as events.
  339.     In your event configuration, make sure everything is spelt correctly.
  340.     Please refer to section 3b for more information.
  341.  
  342.  Q: It just wont work, why?
  343.  A: If your having major problems, please call/mail the support site mentioned
  344.     in section 7
  345.  
  346.  Q: Why do I get an "Error 2 - ...." message?
  347.  A: Check and make sure your computers clock is set to the right date.
  348.     Festivity only makes bulletins up to January 1st 2020.  Considering this
  349.     version of Festivity was first published in 1994, and if its now 2020, it
  350.     may be wise to upgrade this software since 26 years of passed.
  351.  
  352. ┌─────────────────────────────────────────────────────────────────────────────┐
  353. │ What's New                                                                9 │
  354. └─────────────────────────────────────────────────────────────────────────────┘
  355.  
  356.  CC-Holiday v1.0 production finished (April 20th 1993)
  357.  - ANSI/ASCII bulletin support
  358.  - Main setup program created
  359.  - Main event program created
  360.  
  361.  Festivity v2.0 production finished (June 11th 1994)
  362.  - Program name changed
  363.  - ANSI/ASCII/RIP bulletin support
  364.  - Rewrite of configuration program
  365.  - Upgrade of main event program
  366.    - RIP Graphics added
  367.    - Specific ANSI/ASCII alterations
  368.    - Detailed Error message generator
  369.    - Bulletin date bug corrected
  370.    - Bulletin creation date extended to 2020
  371.  
  372.  Festivity v3.0 production to be started in the near future!
  373.  - Addition of American holidays