home *** CD-ROM | disk | FTP | other *** search
/ Aminet 10 / aminetcdnumber101996.iso / Aminet / comm / bbs / clchat414.lha / CLChat414 / ChatBot / ChatBot.Doc < prev    next >
Text File  |  1995-12-25  |  7KB  |  201 lines
  1.                                 ***********
  2.                                 * ChatBot * 
  3.                                 ***********
  4.  
  5.                      - THE Bot for your ClChat System -
  6.  
  7.  
  8.  
  9. Disclaimer
  10. ==========
  11.  
  12. Chatbot is run at your own risk.  There are no warranties given with the bot,
  13. expressed or implied.  This piece of software has not been found to cause any
  14. destructive behaviour on any system it's been tested on.
  15.  
  16.  
  17. What's a BOT?
  18. =============
  19.  
  20. A bot is a piece of software that is intended to loosely resemble a human being
  21. on the IRC or ClChat networks.  Since we're only referring to the ARCNet and
  22. other ClChat networks here, we won't be mentioning the IRC again.
  23.  
  24. The bot serves several uses - it can automatically op certain users when they
  25. join a particular channel, it can act as a gateway between users and your
  26. system by running AmigaDOS commands, it can generally make channel and server
  27. operators lives easier.  Bots can also provide a lot of background noise.  Why
  28. anyone would want to setup their bot to do this is unknown.
  29.  
  30.  
  31. ChatBot
  32. =======
  33.  
  34. ChatBot is a bot for ClChat systems only.  Attempting to make it work with the
  35. IRC is futile at this point.  If you're running a ClChatServer, the command
  36. line options for chatbot are as follows:
  37.  
  38. ChatBot [HOST <hostname>] [PORT <port #>] <nickname> <realname> [channel to
  39.          join] [Config Directory]  (all on one line)
  40.  
  41. or, the AmigaDOS template is :
  42.  
  43. ChatBot Host/K,Port/K/N,Nick/A,Realname/A,Channel=Autojoin/K,Dir=CFGDir/K
  44.  
  45. The server/port is an optional argument.  The default action is to connect to a
  46. server on the host machine ChatBot is being run on.  You MUST include the HOST
  47. (and PORT, if needed) keyword(s) when using them to connect to a remote host.
  48.  
  49. The channel for chatbot to join is an optional argument.  The default
  50. channel for chatbot is MAIN.
  51.  
  52. The config directory is the last optional argument.  The default config
  53. directory for ChatBot is S:
  54.  
  55. It is advisable to run >nil: chatbot unless you really want everything chatbot
  56. 'sees' to be dumped to the CLI you fire it up from.
  57.  
  58. When chatbot fires up, it looks in the config directory for chatbot.cmds,
  59. chatbot.patterns, and chatbot.users.
  60.  
  61. If all goes well the bot should appear in whichever channel you've told it to
  62. move into, and the bot on its own has some default commands:
  63.  
  64. status - Shows your status or access level with the bot.
  65.  
  66. version - Shows chatbot's version.
  67.  
  68. uptime - Shows how long chatbot has been running for.
  69.  
  70. quit - Logs the bot off of chat and quits.  (Status 90 required)
  71.  
  72. reload - Forces the bot to reload it's configuration files.  (Status 90 req'd)
  73.  
  74. shutup - Keeps chatbot from responding to chatbot.patterns.
  75.  
  76. talk - Re-Allows chatbot to respond to patterns in chatbot.patterns.
  77.  
  78. seen - Chatbot keeps track of the users that join and leave while running,
  79.        and using "seen <username>" will show the last time chatbot saw that
  80.        user online.
  81.  
  82. msg - msg will allow you to send a message to a user who is not currently
  83.       online, which chatbot will privately deliver as soon as chatbot sees
  84.       the user again.  USAGE: "msg <username> <message>"
  85.  
  86.  
  87. Chatbot.Cmds
  88. ============
  89.  
  90. This is a text file that allows you to add commands to the bot complete with
  91. access level for each command.  Each line of the file should contain one
  92. command, access level, and AmigaDOS command to execute.  A "%s" on the line
  93. will be replaced with any flags that are given to the bot along with the
  94. command.  A "%n" on the line will be replaced with the name of the user that
  95. issued the command to the bot.  The format of each command line is :
  96.  
  97. CommandName Minimum-Access-Required AmigaDOS-Command-To-Be-Executed
  98.  
  99. Have a look at the supplied example Chatbot.Cmds file to get a good
  100. understanding of how the commands are laid out.
  101.  
  102.  
  103. ChatBot.Users
  104. =============
  105.  
  106. This text file allows you to define access levels for users that chatbot may
  107. run into while in ClChat.  The access levels determine which chatbot commands
  108. they may use, and also determines whether the user will be op'ed by the bot
  109. when they enter the channel the bot is sitting in.  The format of each line of
  110. this file is :
  111.  
  112. UserName Access-Level Auto-Op-Flag Optional-Text
  113.  
  114. The Username may contain AmigaDOS wildcards.  The Access Level is a number
  115. between 0 and 99.  The Auto Op Flag is either Y or N.  The Optional Text is
  116. displayed publically whenever the specified user joins the channel the chatbot
  117. is in.
  118.  
  119. Again, have a look at the supplied example ChatBot.Users file to get a good
  120. understanding of it.
  121.  
  122.  
  123. ChatBot.patterns
  124. ================
  125.  
  126. This text file allows you to give the chatbot a particular action when it
  127. receives the specified text publically.  It can give some sort of really
  128. horrible "Artifical Intelligence" sense to your bot - or it can make for quite
  129. a nuisance.  At any rate, the format for each line in this file is :
  130.  
  131. Pattern-to-Match AmigaDOS-Command-To-Execute
  132.  
  133. The pattern to match is any AmigaDOS type pattern, and for most things you will
  134. want the command it executes to be an AmigaDOS Echo command.
  135.  
  136. The supplied example ChatBot.Patterns file gives good examples of how this
  137. works.
  138.  
  139.  
  140. SendChatBot
  141. ===========
  142.  
  143. SendChatBot allows you to have the bot emit strings from script files or at
  144. specified times.  This can cause for more annoyances, but can be rather cute,
  145. too. 
  146.  
  147. CLI Usage is : SendChatBot <BotNickName> <text>
  148.  
  149.  
  150. SendChatBotFile
  151. ===============
  152.  
  153. SendChatBotFile allows you to set up your bot to send files via DCC.
  154.  
  155. CLI Usage is : SendChatBotFile <BotNickName> <File Recipient> <Filename> [DCC
  156.                Command]   (All on one line)
  157.  
  158. If you put this in your Chatbot.cmds file, you'll want to RUN SendChatBotFile,
  159. otherwise it will tie up the bot for the entire transfer.
  160.  
  161. For example, your entry might be :
  162.  
  163. get 0 run SendChatBotFile MyBot %n BotFile:%s DCCDir:DCC.SEND.AS225
  164.  
  165.  
  166. Copyright
  167. =========
  168.  
  169. ChatBot is Copyright (C) 1994-1995 Oliver Wagner, All Rights Reserved.
  170.  
  171. ChatBot may be distributed freely as long as it is distributed with the
  172. ClChat System as a whole archive, and the files are not modified in any way.
  173.  
  174.  
  175. Bugs
  176. ====
  177.  
  178. Please send bug reports, suggestions and comments via E-Mail to 
  179. o.wagner@lsd.wupper.de.
  180.  
  181.  
  182. Updates
  183. =======
  184.  
  185. Updates are placed on AmiNet, and can also be downloaded via anonymous FTP
  186. directly from pluribus.wupper.de.  You can also check out anonymous FTP at the
  187. servers listed in the ARCnet reference if they have a better link to your host.
  188.  
  189.  
  190. Credits
  191. =======
  192.  
  193. - Credit must go to Oliver Wagner for creating the ClChat System and AMIRC
  194. (two packages I use regularly).  We're awaiting anxiously (but patiently) for
  195. Connectline, Olli!  Keep up the good work!
  196.  
  197. - Adam Clark for hours and hours of testing.
  198. - Laurence Walton for hours and hours of testing.
  199.  
  200. This document was put together by Adam Clark (aclark@direct.ca).
  201.