home *** CD-ROM | disk | FTP | other *** search
/ Carsten's PPE Collection / Carstens_PPE_Collection_2007.zip / S / SCHAT022.ZIP / SICKCHAT.DOC < prev    next >
Text File  |  1996-04-09  |  14KB  |  325 lines
  1.            ▄▄▓▄                  ▄▓        ▄▓▄       ▓▄▄             ▓▄
  2.       ▄▄▄▓██  ▀█▓▄▄▄▄       ▄▄▄▓██    ▄▄▄▓██ ▀█▓▄▄▄▄   ██▓▄▄▄       ▐█▓▄ fl
  3.   ▄████████    ███████▓▄▄████████ ▄████████   ███████▓▄ ████████▄   ████▓▄▄
  4.    ▀▀▓████      ████▓▀ ▀▓████▀▀▀ ▀▓███████     ████▓▀▀   ███████▓▀ ███████▀▀
  5.       ▀▓█▄▄▄     █▓▀      ▄▄▄▓▓    ▓████▓       █▓▀       ▓████▓  ███▓▀▀▀
  6.        ▀ ▀▓▀▀█▓▄▄ ▀       ▐████     ▓████        ▀        ▓███▓  ▀▓▄
  7.       ▄▓▄       ▀█▓▄      ▓███▓▄    ▓███▓▄       █▓▄     ▄▓███▓     ██▓▄▄▄▄
  8.    ▄▄▓████      ████▓▄   ▓██████   ▓██████      ████▓▄▄  ██████▓     ███████▓▄
  9. ▄▓█████████    ███████▓▄▓████████▄▓████████    ███████▓▀████████▓▄    ████▓▀▀
  10.     ▀▀▀▀▓███  ███▓▀▀▀      ▀▀▀▀▓███  ▀▀▀▀▓███ ▄███▓▀▀▀ ███▓▀▀▀▀        █▓▀
  11.            ▀▓▀▀                   ▀▓▀       ▀▓▀▀     ▀▓▀                ▀
  12.  
  13. Program      : SickChat.
  14. Version      : 0.22.             This program requires Clark Development
  15. Coder        : Flax.            Company's PCBoard version 15.21 or higher
  16. Release Date : 1 May 1996.
  17.  
  18.  
  19. - -─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ --─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ -
  20.                         Contents of this Document
  21. - -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙──-─--─ -░-- -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙─∙──-─--─ -░-
  22.  
  23.                         - What is Sickchat?
  24.                         - Disclaimer
  25.                        -- Installing Sickchat.
  26.                         - Commands in chat.
  27.                         - Display and Control files.
  28.                         - The Chat Screens
  29.                         - Page Tunes
  30.                         - Chatcfg
  31.                         - Platemgr
  32.                         - Extra Notes
  33.                         - Contacting the Author.
  34.                         - Other Flax [SiCK] Prods.
  35.                         - Creditz and Greetz.
  36.  
  37.  
  38. - -─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ --─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ -
  39.                              What is Sickchat?
  40. - -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙──-─--─ -░-- -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙─∙──-─--─ -░-
  41.  
  42.  Sickchat allows the sysop of a PCBoard BBS to chat with her/his users.
  43.  Some Features:
  44.  
  45.    - Up to 99 configurable ansi Chat screens. (5 if unregistered)
  46.    - Definable windows for both sysop and user.
  47.    - Word wrapping.
  48.    - Chat logging to a file.
  49.    - Lock user's keys.
  50.    - In-Chat User Editor.
  51.    - Up to 99 Macro's. (5 if unregistered)
  52.    - Beep the other user.
  53.    - External Page tunes.
  54.    - Change text color simply with the UP and DOWN keys.
  55.  
  56.    - Backspace up a line. This means if you are at the extreme left of a
  57.      window and you hit backspace, your cursor jumps to the end of the prev-
  58.      ious line. (NOTE: This only works when the chat is NOT being logged to
  59.      a file. We dont want people changing what's already been logged do we??)
  60.  
  61.    - plus a million other things..
  62.  
  63. - -─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ --─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ -
  64.                                 Disclaimer
  65. - -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙──-─--─ -░-- -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙─∙──-─--─ -░-
  66.  
  67.  Use at own risk.
  68.  
  69. - -─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ --─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ -
  70.                             Installing Sickchat
  71. - -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙──-─--─ -░-- -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙─∙──-─--─ -░-
  72.  
  73.  1. Unzip the archive into a directory. (duh)
  74.  
  75.  2. Run CHATCFG.EXE to install and configure Sickchat. Remember to run the
  76.     Template Manager to initiate the configuration of the Chat screens. If you
  77.     need help on something, read the "ChatCfg", "Platemgr" and "Extra Notes"
  78.     chapters of this document, or see the section on contacting the author.
  79.  
  80.  3. Run PCBSETUP, go into File Locations (B), select Configuration Files (B),
  81.     and edit a CMD.LST entry to look something like this:
  82.  
  83.        Command   Security   PPE/MNU File or Keystroke Replacement
  84.        -------   --------   -------------------------------------
  85.        O         20         C:\PCB\PPE\CHAT\CHAT.PPE
  86.  
  87.  4. Edit PCBTEXT entry #333:
  88.  
  89.       [OLD]       Hello, this is @OPTEXT@.~~
  90.       [NEW]       !C:\PCB\PPE\CHAT\CHAT.PPE /NOPAGE
  91.  
  92.  Of course your paths might not be the same..
  93.  
  94.  The "/NOPAGE" parameter will force Sickchat to go straight into chat,
  95.  without asking the user to enter a page reason.
  96.  
  97.  Sickchat can also be run with the "/LOGFILE" parameter. This will automatic-
  98.  ally begin logging the conversation to CHATLOG.<node> as soon as the chat
  99.  begins.
  100.                Eg. !C:\PCB\PPE\CHAT\CHAT.PPE /LOGFILE
  101.  
  102.  
  103.  If you would like to use Sickchat's ability to limit the amount of times a
  104.  user may page you per call, you must install the Statistic PSA onto your
  105.  system. Please see your PCBoard documentation for info on how to do this.
  106.  
  107. - -─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ --─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ -
  108.                              Commands in Chat
  109. - -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙──-─--─ -░-- -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙─∙──-─--─ -░-
  110.  
  111.  Commands for both sysop and user:
  112.  
  113.       CTRL-Z  - View Help.
  114.       CTRL-W  - Clear your Window.
  115.       CTRL-R  - Redraw the Screen.
  116.       CTRL-Y  - Clear Current line.
  117.       CTRL-G  - Beep.
  118.      UP/DOWN  - Change Text Color.
  119.  
  120.  Commands for the Sysop -- and User if she/he is allowed:
  121.  
  122.       CTRL-A  - Add to the macro list.
  123.       CTRL-V  - View Macro List.
  124.          ESC  - Exit Chat.
  125.  
  126.  Sysop Only Commands:
  127.  
  128.       CTRL-D  - Display external text file.
  129.       CTRL-L  - Lock/Unlock user's keys.
  130.       CTRL-F  - Toggle File Logging.
  131.       CTRL-E  - Edit User's Account details.
  132.  
  133.       CTRL-O  - Move forward one screen.
  134.       CTRL-J  - Jump to a particular screen.
  135.  
  136.  
  137. - -─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ --─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ -
  138.                          Display and Control Files
  139. - -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙──-─--─ -░-- -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙─∙──-─--─ -░-
  140.  
  141.  SCHAT-XX.PCB - The chat screens.
  142.  
  143.  S-PAGE.PCB   - The paging screen.
  144.  
  145.  S-BUSY.PCB   - Displayed a) when you dont answer a page.
  146.                           b) when you abort a user's page by hitting escape.
  147.                           c) when the user aborts their own paging with ESC.
  148.  
  149.  S-TIMES.PCB  - Displayed when the user pages you outside paging hours.
  150.                 The paging hours are defined in PCBSETUP.
  151.  
  152.  S-EXCEED.PCB - Displayed when the user attempts to page you more times than
  153.                 she or he is allowed.
  154.  
  155.  BADNAMES.LST - A List of all users who you dont want to be able to page you.
  156.  
  157.  S-BLIST.PCB  - Displayed when a user pages who is listed in BADNAMES.LST.
  158.  
  159.  MACRO.LST    - A list of Macros, used by Chatcfg's macro editor. This file
  160.                 can also be edited with any text editor.
  161.  
  162.  
  163. - -─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ --─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ -
  164.                             The Chat Screens
  165. - -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙──-─--─ -░-- -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙─∙──-─--─ -░-
  166.  
  167.  "SCHAT-xx.PCB" may be PCB or ANSI coded text files, but they must have the
  168.  extension ".PCB".
  169.  
  170.  Filename format: "SCHAT-" + Screen number + ".PCB".
  171.                   Screen numbers less than 10 are preceded with a "0".
  172.  
  173.           Eg. "SCHAT-03.PCB", "SCHAT-12.PCB", "SCHAT-57.PCB".
  174.  
  175.  
  176.  IMPORTANT : If you have the screens 1, 2, 3 and 5, Sickchat will only use
  177.  the first 3 screens because 4 is missing, and you cannot use (CTRL-J) to
  178.  jump to the 5th screen. If you had sickchat configured to randomly select a
  179.  chat screen, it will only randomly select from the first 3 in this scenario.
  180.  
  181.  
  182. - -─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ --─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ -
  183.                                 Page Tunes
  184. - -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙──-─--─ -░-- -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙─∙──-─--─ -░-
  185.  
  186.  Three External page tunes are included in S-TUNES.ZIP, along with a
  187.  conversion table which tells you what frequencies make what notes.
  188.  
  189.  The format of the SPAGE-xx.SIK tune file is:
  190.  
  191.  Lines 1-3 : Comments on this page tune..
  192.  Line    4 : Amount of notes
  193.  Lines  5+ : Each note, and the length (in milliseconds) to play it. So to
  194.              play the note C-Sharp (3rd octave) for half a second, the line
  195.              would be "284 50".
  196.  
  197.  
  198. - -─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ --─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ -
  199.                                  ChatCfg
  200. - -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙──-─--─ -░-- -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙─∙──-─--─ -░-
  201.  
  202.  Things you should know about some of the options in Chatcfg:
  203.  
  204.  ChatCfg > Toggles > Write to Cmnt1+2
  205.  ------------------------------------
  206.  Comment1 and Comment2 are small fields which all users have, that can be
  207.  viewed by the Sysop by hitting ALT-H a few times. Setting this to YES will
  208.  allow Sickchat to overwrite these fields with the user's page reason. This
  209.  way, when you switch on the monitor and see the little "p" flashing, and you
  210.  want to know why the user has paged you, you can hit ALT-H and read the
  211.  Comment1 and Comment2 fields.
  212.  
  213.  ChatCfg > Toggles > Stuff (C)omment
  214.  -----------------------------------
  215.  If you set this to YES, Sickchat will stuff the keyboard with C + <enter>
  216.  after a failed page attempt. It allows the user to (C)omment to Sysop if
  217.  they cannot talk to you for any of the following reasons:
  218.  
  219.  a) you dont answer a page
  220.  b) you abort their page
  221.  c) they abort their own page
  222.  d) they page outside paging hours
  223.  e) they are listed in BADNAMES.LST
  224.  
  225.  Set this to YES if you have "C" as (C)omment to Sysop in all confs.
  226.  
  227.  Chatcfg > Toggles > Refund user's time
  228.  --------------------------------------
  229.  If this is set to YES, the user's time is not *Suspended*, but their time
  230.  that is used up while in chat will be refunded when the chat ends. But if
  231.  their time runs out while they are chatting to you, they WILL be hung up.
  232.  
  233.  
  234. - -─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ --─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ -
  235.                                  PlateMgr
  236. - -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙──-─--─ -░-- -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙─∙──-─--─ -░-
  237.  
  238.  Platemgr is a utility to manage your chat screens.
  239.  It can be run externally or from inside ChatCfg.
  240.  
  241.  PlateMgr > Allow CLREOL
  242.  -----------------------
  243.  Only set to YES if the chat screen you are configuring has no Right border
  244.  for both the Sysop and User's chat windows! Simple but very important!!
  245.  
  246.  Platemgr > Position of Help Line
  247.  --------------------------------
  248.  Try to position the Help Line somewhere outside where the Help Screen will
  249.  appear, or your Help Screen may be over written by the Help Line.
  250.  
  251.  
  252. - -─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ --─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ -
  253.                                Extra Notes
  254. - -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙──-─--─ -░-- -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙─∙──-─--─ -░-
  255.  
  256.  - You can set the hours that users can page you in PCBSetup > Configuration
  257.    Options > Limits > Allow Sysop Page Start/Stop Time. Make sure you change
  258.    it for every node.
  259.  
  260.  - If you dont like Sickchat's paging feature, you can use an external PPE
  261.    instead. This would be done simply by changing the CMD.LST option to run
  262.    the paging PPE rather than Sickchat. The paging PPE should then execute
  263.    Sickchat if you decide to answer the user's page. Personally I think the
  264.    internal paging feature kickth thum ath.
  265.  
  266.  - The online user editor (Ctrl-E) is not very comprehensive. If you would
  267.    prefer a different user editor PPE, run it as one of PCB's function keys.
  268.  
  269.  - The "Max Pages per call" function in Sickchat requires the Statistics PSA
  270.    is installed on your system. This can be done in PCBSM.
  271.  
  272.  - BADNAMES.LST may contain Names or Aliases.
  273.  
  274.  - Platemgr reads SAUCE records for the Author of each Chat screen.
  275.  
  276.  - You might want to execute an Artificial Intelligence Chat PPE from inside
  277.    S-TIMES.PCB, so if a user pages after hours, the A.I.Chat runs and talks
  278.    to your users.
  279.  
  280.  
  281. - -─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ --─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ -
  282.                            Contacting the Author
  283. - -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙──-─--─ -░-- -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙─∙──-─--─ -░-
  284.  
  285.  If you have a problem with this or any SiCK prods, or you just wanna say hi!,
  286.  do so any of the following ways:
  287.  
  288.               E-mail:  flax@axis.jeack.com.au
  289.         WWW Homepage:  http://www.jeack.com.au/~flax
  290.          or my board:  The Psychotic BBS : +613 9 571 7456
  291.  
  292.  -- Any response is appreciated !
  293.  
  294. - -─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ --─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ -
  295.                           Other Flax [SiCK] Prods
  296. - -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙──-─--─ -░-- -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙─∙──-─--─ -░-
  297.  
  298.  Special Offer: Receive all 5 fully registered SiCK productions for just $25!
  299.                 See REGISTER.DOC for details..
  300.  
  301.  [SiCK PPE DIVISION]
  302.  
  303.  SCHAT022.ZIP - SickChat - Sysop Chat PPE.           [Updated 01 Apr 96]
  304.  SAREA002.ZIP - SickArea - File Area Selector PPE.   [Updated 01 May 96]
  305.  SJOIN021.ZIP - SickJoin - Conference Join PPE.      [Updated 15 Jan 96]
  306.  SPROTV01.ZIP - SickProt - Protocol Selector PPE.
  307.  
  308.  [OTHER]
  309.  
  310.  SNEWS352.ZIP - SickNews - News Util for all BBS types [Updated 01 May 96]
  311.  
  312.  
  313. - -─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ --─░-░-─-∙-∙─∙─-─-─-░─░──∙∙∙─∙─∙──░-─ -
  314.                                   Creditz
  315. - -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙──-─--─ -░-- -░-∙∙-─∙-─-∙─░-░-─-─-─∙─∙─∙──-─--─ -░-
  316.  
  317.  [Credz]
  318.  
  319.  Coding, Docs, most artwork and diz! by FLAX [SiCK]
  320.  Chat screens by various artists - some without permission (sorry)
  321.  Testing by Wizard[Toxic_Krystal] and Wolverine[AV] - tnx dudes
  322.  
  323.  
  324.  To Alanis Morissette and everyone - Enjoy!
  325.