OtfBot API Documentation

Module Index

  • otfbot_plugin - Twistd plugin to start the bot
  • genconfig_plugin - A Twistd plugin to generate a initial configuration file for OTFBot
  • otfbot - the main package of otfbot
    • otfbot.lib - library and helper modules for the bot
      • otfbot.lib.chatMod - contains a abstract class for a Bot-module
      • otfbot.lib.color - No module docstring; 3/3 functions documented
      • otfbot.lib.eliza - a simple eliza ki implementation with regular expressions
      • otfbot.lib.functions - Contains some helper functions
      • otfbot.lib.pyniall_sqlite - a simple markov-chain ki implementation with sqlite backend
      • otfbot.lib.urlutils - Some functions to simplify handling of HTTP-requests
      • otfbot.lib.user - Objects to represent users
      • otfbot.lib.vername - Calculate a pronounceable name from a git version
      • otfbot.lib.version - Provides global version information
    • otfbot.plugins - Plugins for services
      • otfbot.plugins.ircClient - plugins for the ircClient service
        • otfbot.plugins.ircClient.answers - Send answers from file based on regexes
        • otfbot.plugins.ircClient.auth - Authenticates a user to the Bot
        • otfbot.plugins.ircClient.autorejoin - Rejoin, if kicked. (note: this is often a bad idea!)
        • otfbot.plugins.ircClient.badwords - Kick user from a channel based on a list of bad words
        • otfbot.plugins.ircClient.blowcrypt - Support for blowfish cryption on irc
        • otfbot.plugins.ircClient.chapterbot - Record a series of user generated events with time stamps
        • otfbot.plugins.ircClient.checkbox - marks randomly checkboxes [ ] (or not) - and or - one radiobuttons ( ) from a list of checkboxes &| radiobuttons
        • otfbot.plugins.ircClient.commands - React to !commands with text from a commands.txt file
        • otfbot.plugins.ircClient.controlIRC - Access the control service via IRC to control the Bot.
        • otfbot.plugins.ircClient.controlServer - Helper Plugin for the ircServer service
        • otfbot.plugins.ircClient.ddate - Calculate the discordian Date
        • otfbot.plugins.ircClient.eightBall - Provide some aid to make a decision
        • otfbot.plugins.ircClient.feed - Post Headlines and Links from a Newsfeed
        • otfbot.plugins.ircClient.flyspray - Provide a command to information for a bug in a Flyspray bug tracker
        • otfbot.plugins.ircClient.google - Query Google services. Currently only googlefight is implemented.
        • otfbot.plugins.ircClient.human - Helper Plugin for ircServer service to enable external clients to have the same view as the Bot.
        • otfbot.plugins.ircClient.icecast - get information from an icecast-server
        • otfbot.plugins.ircClient.identify - Identify the Bot to a nickserv, if the botnick is registered
        • otfbot.plugins.ircClient.jc - Johnny-Controletti-like game about money, debt and counterfeited money
          • otfbot.plugins.ircClient.jc.game - implements the JC-Game.
          • otfbot.plugins.ircClient.jc.plugin - Johnny-Controletti-like game about money, debt and counterfeited money
        • otfbot.plugins.ircClient.karma - Track the karma of user supplied terms
        • otfbot.plugins.ircClient.keepnick - Undocumented
        • otfbot.plugins.ircClient.ki - Try to emulate a normal user by answering
        • otfbot.plugins.ircClient.kurs - Fetch current stock prices
        • otfbot.plugins.ircClient.log - Log channel conversations to files.
        • otfbot.plugins.ircClient.marvin - complain like Marvin from the Hitchhiker's Guide to the Galaxy
        • otfbot.plugins.ircClient.math - Calculate a random number
        • otfbot.plugins.ircClient.mirror - Mirror the activities of one channel into another
        • otfbot.plugins.ircClient.mode - Let the Bot modify other users flags
        • otfbot.plugins.ircClient.moon - Calculate the current phase of the moon
        • otfbot.plugins.ircClient.noautorejoin - ban users who use autorejoin
        • otfbot.plugins.ircClient.quotesfromweb - Sends quotes and proverbs to the channel
        • otfbot.plugins.ircClient.reminder - No module docstring; 1/2 classes documented
        • otfbot.plugins.ircClient.seen - Undocumented
        • otfbot.plugins.ircClient.statistics - Calculate some statistics, like peak usercount.
        • otfbot.plugins.ircClient.svn - Periodically checks a subversion repository for new revisions and posts them
        • otfbot.plugins.ircClient.svn-push - This module gets notified by tcpServer.svn whenever a subversion repository gets updated. It then posts the commit information to the channel specified in the config.
        • otfbot.plugins.ircClient.tictactoe - Tic-Tac-Toe (X and O) game.
        • otfbot.plugins.ircClient.timediff - provide time and compare CTCP times
        • otfbot.plugins.ircClient.tv - Undocumented
        • otfbot.plugins.ircClient.url - Undocumented
        • otfbot.plugins.ircClient.version - Undocumented
        • otfbot.plugins.ircClient.vote - cast a vote with !votecast question and collect answers
        • otfbot.plugins.ircClient.weather - No module docstring; 1/1 classes, 0/1 functions documented
        • otfbot.plugins.ircClient.youtube - search on youtube with !youtube search phrase
      • otfbot.plugins.ircServer - plugins for the ircServer service
        • otfbot.plugins.ircServer.basic - Undocumented
        • otfbot.plugins.ircServer.controlServer - Undocumented
        • otfbot.plugins.ircServer.human - Undocumented
      • otfbot.plugins.remoteCliServer - plugins for the remoteCliServer service
        • otfbot.plugins.remoteCliServer.control - Undocumented
        • otfbot.plugins.remoteCliServer.manhole - Undocumented
      • otfbot.plugins.tcpServer - plugins for the tcpServer service
        • otfbot.plugins.tcpServer.svn-push - Listens on the LineRecieved events from tcpServer and talks to the ircClient plugin "svn-push" to notify it of new commits
      • otfbot.plugins.webServer - plugins for the webServer service
        • otfbot.plugins.webServer.count - Undocumented
        • otfbot.plugins.webServer.hello - Undocumented
      • otfbot.plugins.xmppClient - Undocumented
        • otfbot.plugins.xmppClient.echo - Undocumented
    • otfbot.services - Contains services which adds basic functionality to the bot
      • otfbot.services.amqp - Providing a client interface to IRC
      • otfbot.services.auth - Provides a user registry and authentication
      • otfbot.services.config - configuration service
      • otfbot.services.control - control service, allowing admins to control the bot (i.e. via irc or tcpclient) i
      • otfbot.services.ircClient - Providing a client interface to IRC
      • otfbot.services.ircServer - No module docstring; 4/4 classes documented
      • otfbot.services.remoteCliServer - No module docstring; 1/4 classes documented
      • otfbot.services.scheduler - scheduler service (a simple wrapper around reactor.callLater, i.e. providing a callPeriodic function)
      • otfbot.services.tcpServer - Provides a tcp server interface and makes it availiable through a unix socket and a tcp listener
      • otfbot.services.webServer - Undocumented
      • otfbot.services.xmppClient - connect to a jabber account