CKS Juggernaut
Chaos AI Technology

Table of Contents
¤
About CKS Juggernaut
¤ Features
¤ Installing Perl
¤ Adding/Removing Bots
¤ Managing Authorities
¤ The Configuration Files

Advanced Bot Information
¤ Bot Brains
¤ Command Footers

Advanced Tutorials
¤ Simple CML Tutorial
¤ ChaosML Tutorial (new!)
¤ About MSN Hex Colors
¤ MSN Display Pic/Emoticon Specifications
¤ Creating a Command

Licenses, Copyrights & Credits
¤ GNU General Public License
¤ Copyright Information
¤ Credits

Bot Promotion Methods
¤ Bot-Depot Promote a Bot Forum
¤ BotWork Bot List
¤ CKS Bot Lyst

¤ Change Log

¤ Known Bugs
_________________________________________

Copyright © 2004 Chaos AI Technology.

This manual was created with the free trial version of HelpScribble.
This notice will not appear in manuals created with the full version.




About CKS Juggernaut

¤
Back to Index

About CKS Juggernaut

CKS Juggernaut is a freeware chatterbot program created by Chaos AI Technology. Juggernaut is able to sign a robot on to AOL Instant Messenger, MSN/Windows Messenger, Internet Relay Chat, and also has a webserver interface so that you and your visitors can talk to your bot on the web.

CKS Juggernaut has lots of options to customize your chatterbots. For example, Juggernaut has a selection of Brains that your bot can use in its responses. Also, each individual bot that connects to the web can have its own information that is independant of other bots running from the same program.

Check out the Features list for more information.

This manual was created with the free trial version of HelpScribble.
This notice will not appear in manuals created with the full version.




Features

¤
Back to Index

Features of CKS Juggernaut

CKS Juggernaut has many features. Some of them are as follows:
  • Comes with over 120 commands.
  • Has a built-in temporary blocking system (to stop abusers)
  • A Stars system, a repeat offender will eventually be banned permanently.
  • Has a lot of IM games--games that can be played with the bot or with other players.
  • A webserver inteface (you can chat with your bot online).
  • Four levels of authority: Client (common user), Moderator, Administrator, and Botmaster.
  • Support for multiple Moderators, Admins, and Masters.*
  • Socket controls for MSN: You can list, join, or terminate conversations.
  • MSN Chatroom support with chat topics.
  • AIM Chatroom support with chat topics.
  • Built-in guestbook capability.
  • A command that shows the bot's current statistics.
  • Easy-to-manage bot connections. All bots run from a single Perl script!
  • Support for virtually unlimited screennames to be signed in at once!
  • Highly customizable--you may have two bots running from one script, but they can have opposite personalities!
  • Support for choosable and customizable brains for the bots to reply with.
  • And much, more more!
     
    *Be cautious about your Master users. The Master level has access to very powerful commands that can manipulate data on your computer. Chaos AI Technology cannot be held responsible for any damages your computer may take as a result of granting Master powers to somebody other than yourself.

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.




    Installing Perl

    ¤
    Back to Index

    Installing Perl

    In order to run the bot, you will need to install Perl onto your machine. Here is some detailed information:

    Required Version of Perl: 5.8.X
    Download Location: http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.




    Adding/Removing Bots

    ¤
    Back to Index

    Adding/Removing Bots

    Upon the extraction of your copy of Juggernaut, a folder titled "bots" should exist in the folder you extracted Juggernaut to. This "bots" folder is where all of your bots' connection information is stored, in individual text files (one file for each of your bots). There are a few sample files in there. You may edit and change the sample files to match your own bots' data, or you can create new files.

    Note: If you add/create your own new files to this folder, please remove the sample files from the folder, because the sample usernames probably don't exist or you don't have the passwords, and your bots obviously won't connect without both information being accurate.

    Adding Bots:
    To add a new bot, just drop a text document (.TXT) into the "bots" folder. The filename isn't important, but the contents inside are (see below for some examples).

    Removing Bots:
    To remove a bot's connection, simply move or delete that bot's text document out of the "bots" folder, and (re)start your bot.

    Universal Required Information:
    No matter what the messenger, all bot files will have the following data inside them:
    ScreenName - This is the username the bot uses to connect with (could
      be an AIM screenname, an MSN e-mail address, or IRC nickname for example).
    Password - Self-explanatory, this is the password that it connects with.
    Client - The bot's messenger name (i.e. AIM, MSN, IRC, etc.). Juggernaut only
      supports a limited amount of messengers, so if you put in a messenger
      that's not supported you'll get error messages.

    Sample Bot Connections

    Sample AIM Bot
    ScreenName: codycks
    Password: asecret
    Auto Reconnect: 1
    Client: AIM
    Brain: Juggernaut
    Reply: ./replies/cml/cody
    Data: ./data/profiles/Cody.txt
    Format: CodyCKS
    Profile: ./data/aim/profiles/Cody.html
    Buddies: ./data/aim/buddies/CKS.txt
    Chats: ./data/aim/chats/Cody.txt
    Chat Triggers: ./data/aim/triggers/Cody.txt
    Font: ./data/aim/fonts/Cody.txt
    Specifications:
      ScreenName - The bot's screenname. In this example, it is codycks
      Password - The password that this bot uses to sign on to AIM.
      Auto Reconnect - If 0, the bot won't automatically reconnect. If 1, it does.
      Client - The messenger that this bot signs on to. This is an AIM bot, so it says "AIM"
      Brain - This bot is going to use the Juggernaut reply system.
      Reply - The folder that the Juggernaut replies would be found in.
      Data - Bots have names and ages too! This bot's data file is found in that path.
      Format - How the bot formats its screenname (capitilization and spacing).
      Profile - The path to the bot's AIM profile data.
      Buddies - Where the bot's buddylist can be found.
      Chats - The list of rooms that the bot would auto-join or be locked to.
      Chat Triggers - Little sayings that the AIM bot replies to in chat.
      Font - Where the bot's font color, size, style and face can be found in.

    Sample MSN Bot
    ScreenName: cody@aichaos.com
    Password: asecret
    Client: MSN
    Brain: Nexus
    Reply: ./replies/nexus.txt
    Nick: Cody
    WelcomeMsg: ./data/msn/welcome/Cody.txt
    DisplayPic: ./data/msn/dp/Ferako.png
    Emoticons: ./data/msn/emo/cks.png
    Data: ./data/profiles/Cody.txt
    Font: ./data/msn/fonts/Cody.txt
    Specifications:
      ScreenName - For an MSN bot, this would be the bot's e-mail address (passport).
      Password - The password this bot uses to sign in to MSN.
      Client - For an MSN bot, this would be... MSN
      Brain - This bot uses the Nexus brain (the learning brain)
      Reply - For Nexus, the Reply data is a single text document (not a folder, like in Juggernaut).
      Nick - The bot's MSN display name.
      WelcomeMsg - The file that contains what the bot has to say to a new conversation.
      DisplayPic - The path to the bot's display picture (MSN 6+)
      Emoticons - The path to the bot's emoticon set (MSN 6+)
      Data - Bots need names and ages, etc, too!
      Font - Path to the bot's font face, color, and style.

    Sample IRC Bot
    ScreenName: Ferako
    Password:
    Client: IRC
    Server: irc.whatnet.org
    Port: 6667
    Channel: #lobby
    Brain: Eliza
    Reply:
    Data: ./data/profiles/Cody.txt
    Specifications:
      ScreenName - The nickname the bot would use on IRC.
      Password - Required only for registered nicknames.
      Client - IRC, since this is an IRC bot.
      Server - The IRC server host.
      Port - The IRC port for that server.
      Channel - The channel that the bot should join on connect.
      Brain - This bot uses the Eliza (psychologist bot) brain.
      Reply - Eliza doesn't use reply data. This could be blank or anything else. Not used.
      Data - Again, the bot's profile data.

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.




    Managing Authorities

    ¤
    Back to Index

    Managing Authorities

    What are authorities?
    Authorities are the higher-level users of your bot. By default, all common users are classified as "clients" until you promote them. Moderators, Administrators, and Botmasters are the authorities in CKS Juggernaut.

    The Botmaster Level
    DISCLAIMER
      The Master level has access to very powerful commands that could
      potentially damage or manipulate the data on your computer. The
      Master level is reserved for just that, the bot's MASTER. Do NOT give
      out Master controls to ANYBODY except for YOURSELF. Chaos AI
      Technology takes no responsibility for anything that happens to your
      computer as a result of ignoring this disclaimer.
    Adding the Masters
      Your bot's master list is stored in ./data/authority/master.txt. There are
      a few sample usernames in there. The format for masters, as well as all
      other authorities, goes as follows:
       LISTENER-USERNAME
      For example, some MSN and AIM users:
       AIM-TheBotMaster
       MSN-master@mysite.com
       MSN-my_other_email@mysite.com

    The Administrator Level
    Adding the Admins
      The Admin users are stored in a list at ./data/authority/admin.txt. Again,
      they are sorted by LISTENER-USERNAME. See the Master description for
      examples.

    The Moderator Level
    Adding the Moderators
      Moderators list is at ./data/authority/moderator.txt, again formatted the
      same way that your Admins and Masters lists are, by LISTENER-USERNAME.

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.




    The Configuration Files

    ¤
    Back to Index

    The Configuration Files

    In your bot's config folder, there are several files with the extension .cfg - don't let these file extensions bother you, they are inherently plain-text documents. Just edit them in Notepad to modify their contents.

    Here is the details of what's inside these files:

    startup.cfg - Your bot's startup configuration
    Command Char - The character(s) that triggers commands. i.e. if the command
      char is #, commands are used like #menu, #about, etc.
    Google Key - Not required, but it's used for the Google search command. You can
      register your own Google key here.
    Email Server - An SMTP server that you use to send e-mails. Again, not required, but
      is used by the !email command to send e-mails.
    Email From - The sender of all e-mails sent from your bot.
    Email Subject - The subject of all e-mails sent from your bot.
    Email Name - The name of your bot, for the e-mail footer (i.e. "This e-mail was sent from a
      bot named <email name>")
    MSN Chat Allowed - This is a 0 or 1 flag. If 1, the bot will stay in conversations when mulitple
      people are present. If 0, the bot will leave conversations automatically when somebody
      joins.

    substitution.cfg - Your bot's substitution data
    This file contains all the word(s) that your bot will replace in the message. For example, it could
    turn "U" into "YOU" to make it easier, on your bot's part, to return good responses to the
    message.

    The items are formatted as follows:
      LEVEL==BEFORE==AFTER
       Level - 0 = replace no matter where it's at, 1 = replace if item is alone
       Before - This is what the user has in their message,
       After - And this is what the bot replaces it with.

    server.cfg - Your bot's webserver information
    This file is only used if you run the webserver bot.

    Server Host - The host that the server will run on. A value of localhost usually works
      just fine.
    Server Port - The port. If it's port 80, going to simple http://localhost/ will access your
      site. If not, you'll need to append the port to the URL, like
      http://localhost:2001/              2001 is the default port number.
    Bot Name - For web conversations, this bot name appears above the bot's replies.
    Brain - Webserver bots need brains too.
    Reply - Reply path or file for the brain specified (see Brains for more information)
    Data - Your bot's personal data.

    gui.cfg - Settings for the Graphical User Interface
    Background - The main background color of the GUI dialog box.
    Font Face - The main font face.
    Font Color - Main font color.
    Status BG - Background color for the GUI's status bar.
    Status Font - Font used on the status bar.
    Status Color - Status bar font color.

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.




    Bot Brains

    ¤
    Back to Index

    Bot Brains

    CKS Juggernaut currently supports the brains listed here. Here on this page is listed the variable/value pairs that must be in your bots' connection data, and a short description/requirements on each brain.

    Juggernaut
    This is the original brain for CKS Juggernaut (hence the name). The reply data is a directory (folder) path. CKS Juggernaut runs on one or many CML files.
    Brain: Juggernaut
    Reply: ./replies/cml/sample
      (example)

    Nexus
    The brain from a previous Chaos AI Technology creation, Nexus learns new replies from conversation. It can tend to be quite annoying at times, especially when it first starts out. Nexus's reply data is a single text document.
    Brain: Nexus
    Reply: ./replies/nexus.txt
      (example)
    Note: The file for its brain does not have to exist when you first create the bot. Once it starts talking, the file is created/updated automatically.

    Eliza
    A simple implementation of the classic Eliza bot. This bot doesn't take any reply data, so you can leave the Reply: variable blank in your bot's data (or put anything you like, it's not used).
    Brain: Eliza
    Reply:

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.




    Simple CML Tutorial

    ¤
    Back to Index

    Simple CML Tutorial

    CML (Chaos Markup Language) is a really simple text-based reply system. A sample CML file's source may look like this:
    <cml version="1.0">

    <category>
    Input: HELLO
    Reply: Hello there <get>name</get>!
    </category>

    </cml>

    The Elements
    The CML markup is composed of many HTML-like elements. Here are their usages and descriptions:
    <cml>...</cml>
      The wrapper for the CML file. It may take the attribute version
      (as shown above), but that attribute is not currently used (maybe
      when the next version of CML is created it will be looked at more
      closely).
    <category>...</category>
      The container for one reply item.
    Input:
      This is what the user would say. This should be in ALL CAPS and
      contain minimal punctuation or symbols. You can use any common
      Perl regex here (i.e. parenthesis for narrower matching options).
      A wildcard (*) can be used here too and retrieved by the <star#>
      tags.
    Reply:
      This contains the bot's reply to that input.
    *
      Wildcards (*'s) are used in the Input: portion of a category, and
      their matched values are put into <star1> to <star9>. A maximum
      of 9 wildcards can be used in one message.
    <star1> - <star9>
      These will contain the values matched by the wildcards or regeces.
    <bot>variable</bot>
      Inserts a bot variable (see? That Data: variable comes in handy now)
    <get>variable</get>
      Gets a variable about a user (i.e. name or age)
    <set>style=variable=value</get>
      Sets a variable about the user.
       style = formal (initial caps), or normal (lowercase)
       variable = the variable (i.e. name or age)
       value = what the new value should be
    <system>...</system>
      Anything inside these tags will be evaluated as Perl code.
    <date>
      Current localtime date.
    <time>
      Current value of time()

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.




    About MSN Hex Colors

    ¤
    Back to Index

    About MSN Hex Colors

    If you have experience with HTML color codes, MSN's hex codes are similar, except you reverse the colors (instead of red-green-blue it goes blue-green-red).

    And if you don't have much experience, here's some basic colors and their codes:

    FF0000 Blue
    0000FF Red
    00FF00 Lime*
    FF00FF Fuchsia*
    FFFF00 Cyan
    00FFFF Yellow
    990000 Navy
    000099 Berghundi
    009900 Green*
    990099 Purple*
    999900 Teal
    009999 Gold
    FFFFFF White*
    CCCCCC Silver*
    999999 Gray*
    000000 Black*

    *These codes are the same as HTML codes because they're palindromes.

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.




    MSN Display Pic/Custom Emoticon Specifications

    ¤
    Back to Index

    MSN Display Pic/Custom Emoticon Specifications

    Display Pictures
      ¤ Standard size is 96x96 pixels
      ¤ Must be a PNG image of 256 colors.

    Custom Emoticons
      ¤ Standard height is 19 pixels, width may be between 19 and 300 pixels.
      ¤ Must be a PNG image of 256 colors.

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.




    Making a Command Tutorial

    ¤
    Back to Index

    Making a Command Tutorial

    This tutorial will teach you how to make a simple command: one that returns a random number between two numbers that the user specifies!

    1. Open the command template at "docs/command template.pl"
    2. Save the file in the "commands" folder as "random.pl"
    3. Change the header of the command to show data similar to this (you can word parts however you choose, the header is not important):
    #      .   .             <CKS Juggernaut>
    #     .:...::     Command Name // !random
    #    .::   ::.     Description // Generates a random number.
    # ..:;;. ' .;;:..        Usage // !random <start>-<end>
    #    .  '''  .     Permissions // Public
    #     :;,:,;:         Listener // All Listeners
    #     :     :        Copyright // 2004 Chaos AI Technology
    4. Rename the sub from sub command to sub random
    5. In the space between my ($self,$client,$msg,$listener) = @_; and return "command reply";, insert this code:
    # See if they have a message.
    if (length $msg == 0) {
      return "Give me two numbers, i.e.\n\n"
       . "!random 1-100";
    }

    # Get the two numbers.
    my ($a,$b) = split(/\-/, $msg, 2);

    # Find the range.
    my $range = $b - $a;

    # Pick the random number.
    my $out = int(rand($range)) + $a;
    6. Edit the return "command reply"; to read return "$out";
    7. Edit the data in the footer of the command to reflect your command's information.
    8. Save the command and reload your bot (send it the !reload command).

    Just in case you got lost somewhere, the completed command should look like this:

    #      .   .             <CKS Juggernaut>
    #     .:...::     Command Name // !random
    #    .::   ::.     Description // Generates a random number.
    # ..:;;. ' .;;:..        Usage // !random <start>-<end>
    #    .  '''  .     Permissions // Public
    #     :;,:,;:         Listener // All Listeners
    #     :     :        Copyright // 2004 Chaos AI Technology

    sub random {
    my ($self,$client,$msg,$listener) = @_;

    # See if they have a message.
    if (length $msg == 0) {
      return "Give me two numbers, i.e.\n\n"
       . "!random 1-100";
    }

    # Get the two numbers.
    my ($a,$b) = split(/\-/, $msg, 2);

    # Find the range.
    my $range = $b - $a;

    # Pick the random number.
    my $out = int(rand($range)) + $a;

    return "$out";
    }

    {
    Category => "Random Stuff",
    Description => "Get a random number between two numbers!",
    Usage => "!random <start>-<end>",
    Listener => "All",
    };

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.




    GNU General Public License

    ¤
    Back to Index

    GNU General Public License

    GNU GENERAL PUBLIC LICENSE

    Version 2, June 1991


    Copyright (C) 1989, 1991 Free Software Foundation, Inc.

    59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    Everyone is permitted to copy and distribute verbatim copies

    of this license document, but changing it is not allowed.


    Preamble


    The licenses for most software are designed to take away your
    freedom to share and change it.  By contrast, the GNU General Public
    License is intended to guarantee your freedom to share and change free
    software--to make sure the software is free for all its users.  This
    General Public License applies to most of the Free Software
    Foundation's software and to any other program whose authors commit to
    using it.  (Some other Free Software Foundation software is covered by
    the GNU Library General Public License instead.)  You can apply it to
    your programs, too.

    When we speak of free software, we are referring to freedom, not
    price.  Our General Public Licenses are designed to make sure that you
    have the freedom to distribute copies of free software (and charge for
    this service if you wish), that you receive source code or can get it
    if you want it, that you can change the software or use pieces of it
    in new free programs; and that you know you can do these things.

    To protect your rights, we need to make restrictions that forbid
    anyone to deny you these rights or to ask you to surrender the rights.
    These restrictions translate to certain responsibilities for you if you
    distribute copies of the software, or if you modify it.

    For example, if you distribute copies of such a program, whether
    gratis or for a fee, you must give the recipients all the rights that
    you have.  You must make sure that they, too, receive or can get the
    source code.  And you must show them these terms so they know their
    rights.

    We protect your rights with two steps: (1) copyright the software, and
    (2) offer you this license which gives you legal permission to copy,
    distribute and/or modify the software.

    Also, for each author's protection and ours, we want to make certain
    that everyone understands that there is no warranty for this free
    software.  If the software is modified by someone else and passed on, we
    want its recipients to know that what they have is not the original, so
    that any problems introduced by others will not reflect on the original
    authors' reputations.

    Finally, any free program is threatened constantly by software
    patents.  We wish to avoid the danger that redistributors of a free
    program will individually obtain patent licenses, in effect making the
    program proprietary.  To prevent this, we have made it clear that any
    patent must be licensed for everyone's free use or not licensed at all.

    The precise terms and conditions for copying, distribution and
    modification follow.

    GNU GENERAL PUBLIC LICENSE

    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION


    0. This License applies to any program or other work which contains
    a notice placed by the copyright holder saying it may be distributed
    under the terms of this General Public License.  The "Program", below,
    refers to any such program or work, and a "work based on the Program"
    means either the Program or any derivative work under copyright law:
    that is to say, a work containing the Program or a portion of it,
    either verbatim or with modifications and/or translated into another
    language.  (Hereinafter, translation is included without limitation in
    the term "modification".)  Each licensee is addressed as "you".

    Activities other than copying, distribution and modification are not
    covered by this License; they are outside its scope.  The act of
    running the Program is not restricted, and the output from the Program
    is covered only if its contents constitute a work based on the
    Program (independent of having been made by running the Program).
    Whether that is true depends on what the Program does.

    1. You may copy and distribute verbatim copies of the Program's
    source code as you receive it, in any medium, provided that you
    conspicuously and appropriately publish on each copy an appropriate
    copyright notice and disclaimer of warranty; keep intact all the
    notices that refer to this License and to the absence of any warranty;
    and give any other recipients of the Program a copy of this License
    along with the Program.

    You may charge a fee for the physical act of transferring a copy, and
    you may at your option offer warranty protection in exchange for a fee.

    2. You may modify your copy or copies of the Program or any portion
    of it, thus forming a work based on the Program, and copy and
    distribute such modifications or work under the terms of Section 1
    above, provided that you also meet all of these conditions:

    a) You must cause the modified files to carry prominent notices
    stating that you changed the files and the date of any change.

    b) You must cause any work that you distribute or publish, that in
    whole or in part contains or is derived from the Program or any
    part thereof, to be licensed as a whole at no charge to all third
    parties under the terms of this License.

    c) If the modified program normally reads commands interactively
    when run, you must cause it, when started running for such
    interactive use in the most ordinary way, to print or display an
    announcement including an appropriate copyright notice and a
    notice that there is no warranty (or else, saying that you provide
    a warranty) and that users may redistribute the program under
    these conditions, and telling the user how to view a copy of this
    License.  (Exception: if the Program itself is interactive but
    does not normally print such an announcement, your work based on
    the Program is not required to print an announcement.)

    These requirements apply to the modified work as a whole.  If
    identifiable sections of that work are not derived from the Program,
    and can be reasonably considered independent and separate works in
    themselves, then this License, and its terms, do not apply to those
    sections when you distribute them as separate works.  But when you
    distribute the same sections as part of a whole which is a work based
    on the Program, the distribution of the whole must be on the terms of
    this License, whose permissions for other licensees extend to the
    entire whole, and thus to each and every part regardless of who wrote it.

    Thus, it is not the intent of this section to claim rights or contest
    your rights to work written entirely by you; rather, the intent is to
    exercise the right to control the distribution of derivative or
    collective works based on the Program.

    In addition, mere aggregation of another work not based on the Program
    with the Program (or with a work based on the Program) on a volume of
    a storage or distribution medium does not bring the other work under
    the scope of this License.

    3. You may copy and distribute the Program (or a work based on it,
    under Section 2) in object code or executable form under the terms of
    Sections 1 and 2 above provided that you also do one of the following:

        a) Accompany it with the complete corresponding machine-readable
        source code, which must be distributed under the terms of Sections
        1 and 2 above on a medium customarily used for software interchange; or,

        b) Accompany it with a written offer, valid for at least three
        years, to give any third party, for a charge no more than your
        cost of physically performing source distribution, a complete
        machine-readable copy of the corresponding source code, to be
        distributed under the terms of Sections 1 and 2 above on a medium
        customarily used for software interchange; or,

        c) Accompany it with the information you received as to the offer
        to distribute corresponding source code.  (This alternative is
        allowed only for noncommercial distribution and only if you
        received the program in object code or executable form with such
        an offer, in accord with Subsection b above.)

    The source code for a work means the preferred form of the work for
    making modifications to it.  For an executable work, complete source
    code means all the source code for all modules it contains, plus any
    associated interface definition files, plus the scripts used to
    control compilation and installation of the executable.  However, as a
    special exception, the source code distributed need not include
    anything that is normally distributed (in either source or binary
    form) with the major components (compiler, kernel, and so on) of the
    operating system on which the executable runs, unless that component
    itself accompanies the executable.

    If distribution of executable or object code is made by offering
    access to copy from a designated place, then offering equivalent
    access to copy the source code from the same place counts as
    distribution of the source code, even though third parties are not
    compelled to copy the source along with the object code.

    4. You may not copy, modify, sublicense, or distribute the Program
    except as expressly provided under this License.  Any attempt
    otherwise to copy, modify, sublicense or distribute the Program is
    void, and will automatically terminate your rights under this License.
    However, parties who have received copies, or rights, from you under
    this License will not have their licenses terminated so long as such
    parties remain in full compliance.

    5. You are not required to accept this License, since you have not
    signed it.  However, nothing else grants you permission to modify or
    distribute the Program or its derivative works.  These actions are
    prohibited by law if you do not accept this License.  Therefore, by
    modifying or distributing the Program (or any work based on the
    Program), you indicate your acceptance of this License to do so, and
    all its terms and conditions for copying, distributing or modifying
    the Program or works based on it.

    6. Each time you redistribute the Program (or any work based on the
    Program), the recipient automatically receives a license from the
    original licensor to copy, distribute or modify the Program subject to
    these terms and conditions.  You may not impose any further
    restrictions on the recipients' exercise of the rights granted herein.
    You are not responsible for enforcing compliance by third parties to
    this License.

    7. If, as a consequence of a court judgment or allegation of patent
    infringement or for any other reason (not limited to patent issues),
    conditions are imposed on you (whether by court order, agreement or
    otherwise) that contradict the conditions of this License, they do not
    excuse you from the conditions of this License.  If you cannot
    distribute so as to satisfy simultaneously your obligations under this
    License and any other pertinent obligations, then as a consequence you
    may not distribute the Program at all.  For example, if a patent
    license would not permit royalty-free redistribution of the Program by
    all those who receive copies directly or indirectly through you, then
    the only way you could satisfy both it and this License would be to
    refrain entirely from distribution of the Program.

    If any portion of this section is held invalid or unenforceable under
    any particular circumstance, the balance of the section is intended to
    apply and the section as a whole is intended to apply in other
    circumstances.

    It is not the purpose of this section to induce you to infringe any
    patents or other property right claims or to contest validity of any
    such claims; this section has the sole purpose of protecting the
    integrity of the free software distribution system, which is
    implemented by public license practices.  Many people have made
    generous contributions to the wide range of software distributed
    through that system in reliance on consistent application of that
    system; it is up to the author/donor to decide if he or she is willing
    to distribute software through any other system and a licensee cannot
    impose that choice.

    This section is intended to make thoroughly clear what is believed to
    be a consequence of the rest of this License.

    8. If the distribution and/or use of the Program is restricted in
    certain countries either by patents or by copyrighted interfaces, the
    original copyright holder who places the Program under this License
    may add an explicit geographical distribution limitation excluding
    those countries, so that distribution is permitted only in or among
    countries not thus excluded.  In such case, this License incorporates
    the limitation as if written in the body of this License.

    9. The Free Software Foundation may publish revised and/or new versions
    of the General Public License from time to time.  Such new versions will
    be similar in spirit to the present version, but may differ in detail to
    address new problems or concerns.

    Each version is given a distinguishing version number.  If the Program
    specifies a version number of this License which applies to it and "any
    later version", you have the option of following the terms and conditions
    either of that version or of any later version published by the Free
    Software Foundation.  If the Program does not specify a version number of
    this License, you may choose any version ever published by the Free Software
    Foundation.

    10. If you wish to incorporate parts of the Program into other free
    programs whose distribution conditions are different, write to the author
    to ask for permission.  For software which is copyrighted by the Free
    Software Foundation, write to the Free Software Foundation; we sometimes
    make exceptions for this.  Our decision will be guided by the two goals
    of preserving the free status of all derivatives of our free software and
    of promoting the sharing and reuse of software generally.

    NO WARRANTY


    11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
    FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
    OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
    PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
    OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
    TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
    PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
    REPAIR OR CORRECTION.

    12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
    WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
    REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
    INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
    OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
    TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
    YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
    PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGES.

    END OF TERMS AND CONDITIONS


    How to Apply These Terms to Your New Programs


    If you develop a new program, and you want it to be of the greatest
    possible use to the public, the best way to achieve this is to make it
    free software which everyone can redistribute and change under these terms.

    To do so, attach the following notices to the program.  It is safest
    to attach them to the start of each source file to most effectively
    convey the exclusion of warranty; and each file should have at least
    the "copyright" line and a pointer to where the full notice is found.

        <one line to give the program's name and a brief idea of what it does.>
        Copyright (C) <year>  <name of author>

        This program is free software; you can redistribute it and/or modify
        it under the terms of the GNU General Public License as published by
        the Free Software Foundation; either version 2 of the License, or
        (at your option) any later version.

        This program is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU General Public License for more details.

        You should have received a copy of the GNU General Public License
        along with this program; if not, write to the Free Software
        Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA


    Also add information on how to contact you by electronic and paper mail.

    If the program is interactive, make it output a short notice like this
    when it starts in an interactive mode:

        Gnomovision version 69, Copyright (C) year name of author
        Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
        This is free software, and you are welcome to redistribute it
        under certain conditions; type `show c' for details.

    The hypothetical commands `show w' and `show c' should show the appropriate
    parts of the General Public License.  Of course, the commands you use may
    be called something other than `show w' and `show c'; they could even be
    mouse-clicks or menu items--whatever suits your program.

    You should also get your employer (if you work as a programmer) or your
    school, if any, to sign a "copyright disclaimer" for the program, if
    necessary.  Here is a sample; alter the names:

      Yoyodyne, Inc., hereby disclaims all copyright interest in the program
      `Gnomovision' (which makes passes at compilers) written by James Hacker.

      <signature of Ty Coon>, 1 April 1989
      Ty Coon, President of Vice

    This General Public License does not permit incorporating your program into
    proprietary programs.  If your program is a subroutine library, you may
    consider it more useful to permit linking proprietary applications with the
    library.  If this is what you want to do, use the GNU Library General
    Public License instead of this License.

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.




    Copyright Information

    ¤
    Back to Index

    Copyright Information

    Chaos AI Technology, the Azulians, and Cody Ferako are copyright © 2004 Cerone Kirsle.
    CKS Juggernaut is copyright © 2004 Chaos AI Technology. 
    This bot uses code, excluding Perl libraries, 100% created only by Chaos AI Technology alone. No codes were borrowed or stolen from any other sources. Credits go to the creators of the modules and various contributors as listed in the Credits section.

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.




    CKS Juggernaut Credits

    ¤
    Back to Index

    CKS Juggernaut Credits

    Programmer
    ¤ Cerone Kirsle

    Contributors
    William Hutchinson, Chaos AI Technology
    Matt <matt@cellus-usa.com>
    Bot-Depot

    Testers
    Michael McDonald, Chaos AI Technology
    Daniel da Silva, Chaos AI Technology

    Module Creators
    Keenie, Eric, & Bot-Depot -- MSN Module
    Matthew Sachs -- Net::OSCAR

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.




    Change Log

    ¤
    Back to Index

    Change Log

    3.6 to 4.0
    Included strict and warnings, Juggernaut's code is now more efficient (or better form, anyway).
    Updated the sub &get_date, now it can return any string by filtering in information. For more details:
      &get_date (<location>, <string>[, <time zone>]);

      Examples:
       # Get local time.
       $time_local = &get_date ('local','<hour_12>:<min>:<secs> <ext>');

       # Get the year according to GM time.
       $year = &get_date ('gm', '<year_full>');
    Command sorting feature: the "commands" folder can have additional subfolders, and each subfolder is opened and loaded as a commands folder. The subfolders can only go one level deep. Note: Putting commands into a folder does NOT determine their category in the menu!
    Flood checker reprogrammed. If a user sends more than 7 messages in 10 seconds, they are blocked for 5 minutes X the number of messages sent past the 7th. If they double that limit, sending 14 messages in 10 seconds, they are banned for 24 hours. Sending 21 messages (3X the limit), banned for 72 hours.
    New Copyright Policy: It hasn't been mentioned before, but starting in this release of Juggernaut, you MUST keep the !juggernaut command intact as part of the copyright deal.

    3.5 to 3.6
    Added a message queue for AIM connections (only for normal IM's though).
    Upgraded MSN library to MSN.pm 2.0 - so, major code changes for the MSN connections.
    Updated Azulian Tag game, it now operates on AIM, MSN, and IRC - The first command that uses all three connections.
    A few added MSN handlers.
    There is now a "Send IM" feature on the GUI. However, the catch is that the main GUI is frozen while the dialog box is on screen (i.e. your bots will freeze and possibly lose their connections).
    Dropped the Flash chat for the HTTP Bot (the Flash chat ran horribly slow).

    3.2 to 3.5
    Updated AIM handlers. $chaos->{$sn}->{current_user}->{in_chat} will be 1 if the user is in the chat talking to the bot, or 0 if normal IM. Also, $chaos->{$sn}->{current_user}->{chat} will be the $chat object for use elsewhere in the bot.
    Made some updates to the GUI. Now it should be able to run more smoothly without being as likely to freeze or lag too horribly. Also, I've added a "Bot Data" wizard so you can add, remove, and edit your bots' files from the GUI itself!
    Updated the !perl command so you are able to use $msn and $chat instead of typing out the full hash paths to those variables.
    Finally got around to creating a !shop command. There is also !donate and !info that have to do with points too.
    Made an update to the ChaosML Brain. Now the <random> tag should work correctly (the usage is slightly difference, click here for details...)
    Added a "settings" folder. Similar to config, except files in there are require'd and executed right away (good for setting hashref variables from the very beginning).
    Timestamp customization. You can make the bot log times in the format of "Wednesday, August 18 2004 @ 9:21:53 PM" instead of the standard localtime. Customize the format in ./settings/timeformat.pl

    3.0 to 3.2
    Upgraded AIM bots to Net::OSCAR 1.11 - They now have buddy icon & typing status support.
    Created ChaosML (aka CML 2.0) brain.
    Updated the &panic function: Now the warnings are recorded at ./data/panic.txt
    Updated the repeat-ban system: now the limit is 10 repeats, and after the 7th, 8th, and 9th repeat they get a warning, and on the 10th they're banned for 24 hours.
    Updated user profiles to have "Time=" and "Personality=" instead of That1 through That3. Time zones can be determined in the !tz command, and the sub &time_offset can return the offset of a time zone (or 0 for undefined)
    MSN socket changes are now logged just like messages.

    2.9.00 to 3.0
    Updated MSN handlers. $chaos->{$handle}->{current_user}->{nick} now contains the nickname (display name) of the current user for use elsewhere in the bot.
    Updated the !away command: you can give the MSN bot plain English statuses, like "be right back", "out to lunch", etc. and have their status change accordingly.
    Changed the menu system. Each command has a footer that specifies which category it will be put into in the menu, and you can type !menu lost to see all commands that don't have those footers.
    Now all data (users' data & temporary blocks) are loaded on startup.
    Userdata is more efficient, their files are only opened if they haven't yet been loaded.
    Fixed a bug with brains that don't require preloading.
    Fixed bugs in the MSN actions for !away and !return, so now the status changes will work with the new MSN module.

    2.5.00 to 2.9.00
    Fixed brain support. Now it's easy to add or create your own bot brains.
    Updated MSN kill sockets command, the bot won't abandon the chatroom.
    Added the Eliza brain to the bot.

    2.3.00 to 2.5.00
    ­ Added support for the IRC listener.
    Added a Moderator authority level.
    Added support for multiple responses. Separate each response with <:>
    Added a tag for AIM bots to send their messages as auto-responses.
    Added a few commands.

    2.0.00 to 2.3.00
    Updated MSN.pm to 1.3.11 Beta. Bot should work in multiperson MSN conversations, and the Graphical User Interface is less likely to freeze with the new MSN module. If it causes problems, the previous MSN.pm can be found in the "backup" folder. 
    Created graphical user interface. 
    Added an auto-reconnect function to AIM bots. 
    Added AIM chatroom triggers: Small messages that the bot will respond to in chats, without having to be talked to directly.

    1.5.01 to 2.0.00
    Added built in AIM chatroom settings. You can now specify certain AIM chats for the bot to automatically join or only leave at command of an Admin. 
    Added chat topic support for AIM chatrooms (type "botscreenname topic [new topic]" to get or set the topic). 
    Fixed bugs in AIM buddy in/chat buddy in - it keeps online buddies in a hash and will only print their status once, instead of every time the buddylist updates. 
    Added more flexibility for the bot e-mail command, information such as FROM: and SUBJECT: data is now in the startup.cfg file. 
    Added an option for multiperson MSN conversations to be allowed or not - there was a bug in MSN.pm that would freeze the bot in such a conversation, so it's not recommended to allow it. 
    The shop functionality is still currently suspended. If anyone wants to help me, feel free to contact me or something.

    1.1.00 to 1.5.01
    Added flexibility in bot brains: each bot screenname is able to have its own brain type (Nexus or Juggernaut) and have a different reply set than another bot. 
    Updated webserver to have same brain flexibility as normal Juggernaut bot. 
    Removed the auto flood checker. 
    Added points system, your users can earn points by playing games. 
    Added display picture and custom emoticon support for MSN bots.

    1.0.00 to 1.1.00
    Added bot profiles. Each bot can have their own set of "client data" such as name and age, just like its users can! 
    Update to profile.cml, the bot now stores user gender as "male/female" instead of how the user describes theirself. 
    Added support for MSN welcome messages. 
    Bot leaves the conversation automatically if it's not a multiperson chat that the bot supports (i.e. the bot's chatroom)

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.




    Known Bugs

    ¤
    Back to Index

    Known Bugs

    With the Graphical User Interface (GUI)
      ¤ Bot may run slow, or randomly halt for periods of time.
      ¤ AIM bots with chat-auto-join may freeze or pause the GUI.
      ¤ Having an IRC connection will freeze the GUI.

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.




    Command Footers

    ¤
    Back to Index

    Command Footers

    The new menu/command system includes command footers. The footers are used to determine how the command is listed and shown in the menu, and includes descriptions, how to use the command, and what messenger it's for.

    The keys that ALL commands share are the following:
    Category - What category the command goes into.
    Description - The description of the command.
    Usage - How to use the command.
    Listener - The messenger it's for (i.e. "AIM/MSN", "AIM", "All", etc.)

    There are also a few optional keys that only a few commands use:
    Hidden - If 1, the command won't be listed in the menu.
    Restrict - Restricts the command to a certain user group (i.e. Mod, Admin, Master).
      Commands with restrictions will not be shown to users who don't qualify for
      that level. Also, any menu category that contains a restricted command will
      not be shown (i.e. if you put an Admin command in the "General" category,
      only Admins & Masters can even VIEW the General category at all, even though
      the rest of the commands are public!).

    Here's an example of a command footer with all the keys (blue = optional ones, red = required ones):

    {
    Hidden => 1,
    Restrict => 'Botmaster',
    Category => 'Botmaster Commands',
    Description => 'Big secret command',
    Usage => '!secret',
    Listener => 'All',
    };

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.




    ChaosML Tutorial

    ¤
    Back to Index

    What is ChaosML?

    ChaosML is also known as CML 2.0. While it is an upgrade from the original Juggernaut CML, it is formatted so differently that the two are incompatible with eachother.

    A ChaosML file is formatted like this:
    <cml version="2.0">

    <category>
      <pattern>HELLO</pattern>
      <template>Hello there <get>name</get>! :-)</template>
    </category>

    </cml>

    ChaosML has many of the same tags as CML 1.0, and a couple new tags. Here are all the supported tags:

    ChaosML Supported Tags

    <cml>...</cml>
      This is the wrapper for the CML file, and takes the attribute "version" which
      should equal 2.0 (see example above)

    <category>...</category>
      The wrapper for one reply item, just like before.

    <pattern>...</pattern>
      This is the new "Input" area. Between <pattern> and </pattern> goes what
      the user would have to say to trigger that response.

    <template>...</template>
      This is the response for that input.

    <that>...</that> (new!)
      (Optional) This field would be how the bot last replied, in all caps and with
      no puncuation or special characters. A good example is the Knock Knock
      replies found in ./replies/cml/standard/humor.cml

    <topic>...</topic> (new!)
      (Optional) Replies under a certain topic would have higher matching priority
      than the replies outside of the topic (see <settopic> for information on
      setting the topics). This function currently does not work.

    <date>
      Inserts the current localtime().

    <time>
      Inserts the current value of time().

    <client>
      Inserts the client's username.

    <listener>
      Inserts the client's listener ID.

    <sn>
      Inserts the bot's username.

    <nextreply> (new!)
      Separates replies, each side of a <nextreply> will be sent in a different
      reply.

    <think>...</think> (new!)
      Anything between <think> and </think> will be evaluated in the background
      and not shown in the message. This is useful, for example, if you want to set
      a user's variable without showing the value that was just set.

    <set>style=variable=value</set>
      This will set a variable for the user. style would be either formal (Initial Caps,
      Like For A Name Or Location), or normal for lowercase. Variable is the variable's
      name, and value is what the new value should be.

    <get>variable</get>
      Gets a user's variable and inserts it into the reply.

    <bot>variable</bot>
      Inserts a bot's profile variable.

    <settopic=new topic> (new!)
      Updates the topic (see <topic>...</topic> above). Set the topic to "random"
      to delete the topic.

    <formal>...</formal>
      Formalizes the text between <formal> and </formal>.

    <sentence>...</sentence> (new!)
      Makes the contained text Sentence Case.

    <random>...</random>
      Makes a sub-list of random items. For example, a reply could say "A random
      number from 1 to 9 is: <random>1 2 3 4 5 6 7 8 9</random>" and choose
      a random number. You can use single-items separated by spaces, or larger
      items separated by comma's, i.e. <random>You will be rich,You will be famous,etc...</random>

    <system>...</system>
      Executes code between these tags as Perl code (can be dangerous).

    This manual was created with the free trial version of HelpScribble.
    This notice will not appear in manuals created with the full version.