home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / EVENTS / WCHT322D.ZIP / WWIVCHAT.DOC < prev    next >
Text File  |  1995-08-19  |  10KB  |  295 lines

  1.          
  2.          
  3.          
  4.          
  5.          
  6.          
  7.          
  8.          
  9.                                 W W I V C h a t
  10.  
  11.               "The !ULTIMATE! Inter-Instance Chat for WWIV BBS!"         
  12.  
  13.                                  Version 3.22d
  14.                      
  15.                    External Chat Module for WWIV BBS System
  16.                       Copyright 1993-1995 by Joe Barbara
  17. 
  18.  
  19. CONTENTS
  20.  
  21.   Page 1 :    License Agreement
  22.               Files Included
  23.  
  24.   Page 2 :    Installation
  25.  
  26.   Page 3 :    Configuration
  27.               Multitask Support
  28.  
  29.   Page 4 :    Operation
  30.               Customization of Action File
  31.  
  32.   Page 5 :    Misc.
  33.               Chain Description Support
  34.  
  35.   Page 6 :    Registration 
  36.   
  37.   Page 7 :    Helpful Hints 
  38.  
  39. 
  40. Page 1 
  41.  
  42. LICENSE AGREEMENT:
  43.  
  44. This is a Shareware product.  You are entitled to use the software for a
  45. trial period of 30 days, after which you must pay a registration fee for
  46. continued use or delete the software.  I encourage you to distribute this 
  47. software among your friends, but the same conditions will apply.  Use of 
  48. this product constitutes your acceptance of these terms and conditions and 
  49. your agreement to abide by them.
  50.  
  51. You are allowed to run multiple copies as long as each copy running is
  52. connect via LAN, Multitasker or other means to allow operation on only
  53. one BBS.  Each BBS must register its own copy.  
  54.  
  55. DISCLAIMER:
  56.  
  57. JOE BARBARA PROVIDES THIS SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, 
  58. EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED 
  59. WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE.
  60.  
  61. WWIV BBS is copyrighted by Wayne Bell and WWIV Software Services
  62. /*************************************************************************/
  63.  
  64. FILES INCLUDED:
  65.  
  66.   WWIVCHAT.EXE  The actual Program          (put in main BBS dir)
  67.   WCHT-CFG.EXE  Configuration Editor        (put in main BBS dir)
  68.   WWIVCHAT.ACT  ACTION Word file (default)  (put in GFILES dir)
  69.   WWIVCHAT.HLP  Help file                   (put in GFILES dir)
  70.  
  71.   WWIVCHAT.DOC  This File
  72.   FILE_ID .DIZ  BBS description
  73.   WHATS   .NEW  Enhancements
  74.   REGISTER.FRM  The Registration Form
  75.   REGISTER.LST  List of Sysops who have already registered
  76.  
  77. 
  78. Page 2
  79.  
  80. INSTALLATION:
  81.  
  82.  WWIV 4.23 
  83.  ---------
  84.  A small source modification to the BBS in BBS.C file Procedure main_menu is
  85.  required for WWIVChat to function.
  86.  
  87.  Replace the code in that function with the code below.
  88.  
  89.     if (strcmp(s,"/C")==0) {
  90.       write_inst(INST_LOC_CHATROOM,0,INST_FLAGS_ONLINE);
  91.       if (exist("WWIVCHAT.EXE")) {
  92.      sprintf(s1,"WWIVCHAT.EXE %s",create_chain_file());
  93.      shrink_out(s1,1,0,1,1);
  94.       } else
  95.      chat_room();
  96.     }
  97.  
  98.  WWIV 4.24 +
  99.  -----------
  100.  
  101.  No action required the WWIV.INI file is already correctly set.
  102.  
  103.  ALL Versions
  104.  ------------
  105.  Unzip the whole archive into main BBS directory (the directory where 
  106.  BBS.EXE is).
  107.  
  108.  Type ATTRIB WWIVCHAT.EXE +R after the file is copied to prevent SHARE 
  109.  errors.
  110.  
  111.  Type WCHT-CFG convert old INI files and configure new version. After
  112.  configuration the only required files in the main dir are: WWIVCHAT.EXE,
  113.  WCHT-CFG.EXE, and WWIVCHAT.DAT.  All others may be removed from the
  114.  main dir if desired.
  115. 
  116. Page 3
  117.  
  118. CONFIGURATION:
  119.  
  120.  To configure WWIVChat run the WCHT-CFG.EXE program it will allow 
  121.  you to edit the main system parameters.  A channel editor has also
  122.  been included to configure the rooms/channels.
  123.  
  124.  (R) May be used at the system configuration menu to Read your 
  125.  registration code in automatically.  Simply capture the E-mail I 
  126.  leave you on my BBS with your registration code in it.  Rename the 
  127.  captured file to 'WWIVCHAT.REG' and copy it to the main WWIV 
  128.  directory.  Once that is done just type r at the main configuration 
  129.  screen and your code will be read in with no typing at all!
  130.  
  131.  To change color field in the main configuration fields use the + and -
  132.  keys to cycle the available colors.
  133.  
  134.  MULTITASK  When enabled will display in the upper right hand corner
  135.          the detected multitasker.  LAN users should NOT enable as
  136.          it would only slow their system running the extra code.
  137.  
  138.          DISA - Disabled                   OS2  - Os/2
  139.          DV   - DESQview                   WIN  - Windows
  140.          NONE - Enable but none detected
  141.  
  142.  Poll instance messages - This is value in approximate seconds to check
  143.  for instance messages from WWIV.  Too small of a number will increase
  144.  harddisk activity, too large a number will lengthen the time instances
  145.  messages will be received while in chat.
  146.  
  147. 
  148. Page 4
  149.  
  150. OPERATION:  
  151.  
  152.  There are two modes of chat available, a CB style chat sending one or more
  153.  lines at a time and real time 4-Way Chat available only to ANSI users.
  154.  
  155.  Operations is straight forward using the help screens for most commands.
  156.  
  157. ACTION MODE (Available only in CB Chat):
  158.  
  159.  Action mode is enabled by default upon entry to CB Chat is can be turned
  160.  off and on with the '/A' command.  Action mode allows users to type in silly
  161.  action word that display messages to the recipient as well as other users 
  162.  in chat. To receive a list of available action words type 'LIST'.  To get
  163.  info on a specific action word type VERB ?, all info about it will be
  164.  displayed.  More detailed explanations and examples may be found in the
  165.  on-line help within WWIVChat invoke by the '/H' command.
  166.  
  167.  
  168. CUSTOMIZATION ACTION MODE:
  169.                  
  170.  Sysops may wish to add or modify action verbs and may do so by editing the
  171.  WWIVCHAT.ACT file.  The following five line format must be used for each
  172.  command.
  173.  
  174.    GASP                                  (VERB typed by initiator)
  175.    ...Amazed are ya?                     (Initiator see's this)
  176.    %s is gasping in amazement at %s!     (All other users see this)
  177.    %s is gasping in amazement at you!    (Recipient see's this)
  178.    %s is gasping in sheer amazement.     (All users see if no recipient)
  179.  
  180.  Add %s for sender's name. A second %s in any line will be receiver's name.
  181.  
  182.  Line 5 maybe an '*' indicating that the verb must be used with a recipient
  183.  thus can not be used stand alone.
  184. 
  185. Page 5
  186.  
  187. MISC.
  188.  
  189.  Chain description Support
  190.  
  191.  Support has been added to read the actual name of the chain being run and 
  192.  display it at the menu to enable this feature a 1 line mod must be done
  193.  to the BBS.  Modify file BBSOVL1.C, function void do_chains as below:
  194.  
  195.  void do_chains(void)
  196.     .
  197.     .
  198.     if ((i>0) && (I<=mapp)) {
  199.       done=1;
  200.       curdloads=2;
  201.  /* MOD add below line */
  202.       write_inst(INST_LOC_CHAINS,map[i-1],INST_FLAGS_ONLINE);
  203.  /* END MODIFY */
  204.       run_chain(map[i-1]);
  205.     } else
  206.       if (strcmp(ss,"Q")==0)
  207.  
  208.  The above mod is not necessary WWIVChat will still display the generic
  209.  Chains message but if you wish to display the actual chain name install
  210.  the mod.  Hopefully this mod will not be needed with WWIV v4.24.
  211. 
  212. Page 6
  213.  
  214. REGISTRATION:
  215.  
  216. If you use this program more than 30 days, registration is required.
  217. The fee is $25 per BBS.  ($20 registrations not accepted after 1FEB95)
  218.  
  219. Send payment to: (NO PERSONAL CHECKS ACCEPTED, MONEY ORDER ONLY!!)
  220.  
  221. Joe Barbara
  222. 850B Kirtland Ave.
  223. Middletown, PA 17057-4804
  224.  
  225.  
  226. NAME: __________________________    BBS NAME: ______________________________
  227.  
  228. ADDR: __________________________    SYSOP NAME: ____________________________
  229.  
  230. CITY: __________________________    WWIVnet Addr: __________________________
  231.  
  232. STATE _____ ZIP __________ - ______        Current WWIVChat Ver  ___________
  233.  
  234. VOICE NUMBER: (_____) ______ - __________  Number of active lines __________
  235.  
  236. BBS NUMBER:   (_____) ______ - __________
  237.  
  238. Note:  The BBS number, BBS Name, and Sysop Name must be EXACTLY as typed in 
  239. INIT.EXE (uppercase, lowercase and all spacing). 
  240.  
  241. The only method of payment accepted is a MONEY ORDER period.  This is due to 
  242. the fact that a group of people have send me hot checks costing me more
  243. bucks in service charges than the registration.
  244.  
  245. /*************************************************************************/
  246.  
  247. To receive you reg code you must call my BBS at (717)948-9495
  248.  
  249. So wait a week or so after you send off the registration and call the
  250. BBS and I will E-mail you the code
  251.  
  252. You may want to subscribe to the WWIVChat Support Sub on WWIVnet.
  253.  
  254. Type:   WWIVCHAT
  255. Host:   7171
  256.  
  257. Please send any bug reports or wished enhancements via that sub.
  258.  
  259. 
  260. Page 7
  261.  
  262. Notes for DESQview Users:
  263.  
  264.  1. You need to run DVANSI for any programs that use ANSI.  DESQview
  265.     doesn't use the DEVICE=C:\DOS\ANSI.SYS so it can be removed from the 
  266.     CONFIG.SYS file to save memory.  Modify your BBS batch file to run 
  267.     dvansi before you run the BBS.  For example:
  268.  
  269.     BBS.BAT (listing, Usage: BBS 1, for Inst 1, BBS 2, for Inst 2, ect. )
  270.  
  271.     @ECHO OFF
  272.     SET WWIV_INSTANCE=%1
  273.     DVANSI
  274.     C:
  275.     CD\WWIV
  276.     BBS.EXE %2 %3 %4 %5 %6 %7
  277.  
  278. How to set up a RAM drive
  279.   
  280.   Anyone can have a ram drive to do so add the following command to your 
  281.   CONFIG.SYS file. 
  282.  
  283.   DEVICE=C:\DOS\RAMDRIVE.SYS 256 /A  
  284.  
  285.   That will set up a ram drive of 256k you can change it to whatever you
  286.   like although 256 should be about right for WWIVCHAT.  The RAM drive will
  287.   be named the next available drive letter so if you hard disk is C:
  288.   RAM drive would be named D:.  Once you have it set up edit run WCHT-CFG
  289.   and change the chat path to your new ram drive and the performance
  290.   should greatly increase.
  291.  
  292.   If you are using a network you should do the above then offer the RAM
  293.   drive on the network to other machine to share.
  294. 
  295.