OtfBot API Documentation Modules Classes Names
Clear Help

Search bar offers the following options:

  • Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: +foo bar -baz
  • Wildcards. The below example searches for documents with words beginning with “foo”: foo*
  • Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: +qname:twisted.mail.* +search

    Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

  • Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: foo~1

Results provided by Lunr.js

Module Index

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