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

Class Hierarchy

  • Exception
    • otfbot.plugins.ircClient.jc.game.DoesNotHaveException - Exception for when a user tries to spend money he does not have
    • otfbot.plugins.ircClient.jc.game.NothingPaidException - Exception for when a user tries to pay nothing at all
  • html.parser.HTMLParser
    • otfbot.plugins.ircClient.flyspray.versionIDExtractor - Undocumented
  • object
    • genconfig_plugin.MyServiceMaker - Undocumented
    • otfbot.lib.user.IrcUser - Represents the connection of a BotUser via IRC
    • otfbot.plugins.ircClient.keepnick.Monitor - Undocumented
      • otfbot.plugins.ircClient.keepnick.MonitorMonitor - Undocumented
      • otfbot.plugins.ircClient.keepnick.WatchMonitor - Undocumented
    • otfbot_plugin.MyServiceMaker - Undocumented
  • otfbot.lib.eliza.eliza - Undocumented
  • otfbot.lib.pluginSupport.Plugin
    • otfbot.lib.chatMod.chatMod - this class is mainly for documentation of the callbacks. some functions are helper functions for common tasks, i.e. kicked calls userLeft, so a plugin only implementing userLeft will notice that a kicked user left the channel...
      • otfbot.plugins.ircClient.answers.Plugin - No class docstring; 0/4 instance variable, 2/6 methods documented
      • otfbot.plugins.ircClient.auth.Plugin - Make a query to the bot to prove the users identity:
      • otfbot.plugins.ircClient.autorejoin.Plugin - Undocumented
      • otfbot.plugins.ircClient.badwords.Plugin - No class docstring; 0/3 instance variable, 1/4 method documented
      • otfbot.plugins.ircClient.blowcrypt.Plugin - No class docstring; 0/2 instance variable, 0/1 constant, 3/10 methods documented
      • otfbot.plugins.ircClient.chapterbot.Plugin - Undocumented
      • otfbot.plugins.ircClient.checkbox.Plugin - checkbox/radiobutton plugin
      • otfbot.plugins.ircClient.commands.Plugin - No class docstring; 0/4 instance variable, 1/8 method documented
      • otfbot.plugins.ircClient.controlIRC.Plugin - Control the Bot as a identified user. Either query the Bot and enter the control mode by typing control or use commands in a channel.
      • otfbot.plugins.ircClient.controlServer.Plugin - Undocumented
      • otfbot.plugins.ircClient.ddate.Plugin - Undocumented
      • otfbot.plugins.ircClient.eightBall.Plugin - Undocumented
      • otfbot.plugins.ircClient.feed.Plugin - No class docstring; 0/7 instance variable, 3/12 methods documented
      • otfbot.plugins.ircClient.flyspray.Plugin - Undocumented
      • otfbot.plugins.ircClient.google.Plugin - Undocumented
      • otfbot.plugins.ircClient.human.Plugin - Undocumented
      • otfbot.plugins.ircClient.icecast.Plugin - Undocumented
      • otfbot.plugins.ircClient.identify.Plugin - Undocumented
      • otfbot.plugins.ircClient.jc.plugin.Plugin - jc game plugin
      • otfbot.plugins.ircClient.karma.Plugin - Undocumented
      • otfbot.plugins.ircClient.keepnick.Plugin - Undocumented
      • otfbot.plugins.ircClient.ki.Plugin - Undocumented
      • otfbot.plugins.ircClient.kurs.Plugin - Undocumented
      • otfbot.plugins.ircClient.log.Plugin - No class docstring; 0/8 instance variable, 2/25 methods documented
      • otfbot.plugins.ircClient.marvin.Plugin - marvin plugin
      • otfbot.plugins.ircClient.math.Plugin - Undocumented
      • otfbot.plugins.ircClient.mirror.Plugin - Configuration: If you want to mirror channel #a to channel #b then you need to add mirror.mirrorto: network-#b to the channel configuration of #a where 'network' is the irc network name.
      • otfbot.plugins.ircClient.mode.Plugin - Undocumented
      • otfbot.plugins.ircClient.moon.Plugin - Undocumented
      • otfbot.plugins.ircClient.noautorejoin.Plugin - Undocumented
      • otfbot.plugins.ircClient.quotesfromweb.Plugin - quotesfromweb plugin
      • otfbot.plugins.ircClient.reminder.Plugin - reminder plugin
      • otfbot.plugins.ircClient.seen.Plugin - Undocumented
      • otfbot.plugins.ircClient.statistics.Plugin - Undocumented
      • otfbot.plugins.ircClient.svn-push.Plugin - svn-push plugin
      • otfbot.plugins.ircClient.svn.Plugin - svn plugin
      • otfbot.plugins.ircClient.timediff.Plugin - Undocumented
      • otfbot.plugins.ircClient.tv.Plugin - Undocumented
      • otfbot.plugins.ircClient.url.Plugin - Undocumented
      • otfbot.plugins.ircClient.version.Plugin - Undocumented
      • otfbot.plugins.ircClient.vote.Plugin - Undocumented
      • otfbot.plugins.ircClient.weather.Plugin - This plugin fetches the current weather from yahoo apis. For the places api you need to get an appid token from yahoo at https://developer.apps.yahoo.com/wsregapp/
      • otfbot.plugins.ircClient.youtube.Plugin - No class docstring; 0/3 instance variable, 1/3 method documented
      • otfbot.plugins.ircServer.basic.Plugin - Undocumented
      • otfbot.plugins.ircServer.controlServer.Plugin - Undocumented
      • otfbot.plugins.ircServer.human.Plugin - Undocumented
  • otfbot.lib.pluginSupport.plugin.Plugin
    • otfbot.plugins.tcpServer.svn-push.Plugin - svn-push tcpServer plugin
    • otfbot.plugins.webServer.count.Plugin - Undocumented
    • otfbot.plugins.webServer.hello.Plugin - Undocumented
    • otfbot.plugins.xmppClient.echo.Plugin - Undocumented
  • otfbot.lib.pluginSupport.pluginSupport
    • otfbot.services.ircClient.Bot - The Protocol of our IRC-Bot
    • otfbot.services.ircServer.Server - the server protocol, implemending pluginSupport and IRCUser
    • otfbot.services.remoteCliServer.remoteCLI - No class docstring; 0/1 instance variable, 3/3 methods documented
    • otfbot.services.tcpServer.Server - This is a very simple LineOnlyReceiver. It only supports the callback lineReceived.
    • otfbot.services.webServer.Root - Undocumented
    • otfbot.services.xmppClient.Bot - xmppClient Bot protocol
  • otfbot.lib.pyniall_sqlite.pyNiall - No class docstring; 0/2 instance variable, 9/10 methods documented
  • otfbot.plugins.ircClient.controlServer.Meta - Undocumented
  • otfbot.plugins.ircClient.feed.Meta - Undocumented
  • otfbot.plugins.ircClient.human.Meta - Undocumented
  • otfbot.plugins.ircClient.jc.game.Game - Undocumented
  • otfbot.plugins.ircClient.jc.game.Messages - Stores the Game-Messages, so they can be translated
  • otfbot.plugins.ircClient.jc.game.State - a state, which provides an input-method, and transits to other states on certain events
    • otfbot.plugins.ircClient.jc.game.LostState - Undocumented
    • otfbot.plugins.ircClient.jc.game.NeedToPayState - Undocumented
    • otfbot.plugins.ircClient.jc.game.PaidState - Undocumented
    • otfbot.plugins.ircClient.jc.game.PaybackState - Undocumented
    • otfbot.plugins.ircClient.jc.game.PregameState - Undocumented
    • otfbot.plugins.ircClient.jc.game.SelectPlayerState - Undocumented
    • otfbot.plugins.ircClient.jc.game.WaitingForPlayersState - Undocumented
  • otfbot.plugins.ircClient.jc.game.User - user object
  • otfbot.plugins.ircClient.ki.Meta - Undocumented
  • otfbot.plugins.ircClient.ki.responder - a prototype of a artificial intelligence responder. It does nothing at all, but it contains all the methods needed to extend it for a ai-responder
    • otfbot.plugins.ircClient.ki.elizaResponder - Undocumented
    • otfbot.plugins.ircClient.ki.megahalResponder - implements a responder based on the megahal ai-bot
    • otfbot.plugins.ircClient.ki.niallResponder - Undocumented
    • otfbot.plugins.ircClient.ki.udpResponder - Undocumented
    • otfbot.plugins.ircClient.ki.webResponder - Undocumented
  • otfbot.plugins.ircClient.noautorejoin.Meta - Undocumented
  • otfbot.plugins.ircClient.reminder.Meta - Undocumented
  • otfbot.plugins.ircClient.svn-push.Meta - Undocumented
  • otfbot.plugins.ircClient.tv.Meta - Undocumented
  • otfbot.plugins.ircClient.tv.tv - Undocumented
    • otfbot.plugins.ircClient.tv.tv_otr - No class docstring; 1/3 instance variable, 0/2 method documented
    • otfbot.plugins.ircClient.tv.tv_xmltv - Undocumented
  • otfbot.plugins.ircClient.vote.Meta - Undocumented
  • otfbot.plugins.ircClient.youtube.Meta - Undocumented
  • otfbot.plugins.tcpServer.svn-push.Meta - Undocumented
  • otfbot.services.amqp.Meta - Undocumented
  • otfbot.services.ircClient.Meta - Undocumented
  • otfbot.services.remoteCliServer.SSHRealm - Undocumented
  • twisted.application.internet.TCPServer
    • otfbot.services.ircServer.MyTCPServer - TCPServer, which has self.root, self.parent and self.factory
  • twisted.application.service.MultiService
    • otfbot.services.amqp.botService - No class docstring; 0/5 instance variable, 0/1 class variable, 2/5 methods documented
    • otfbot.services.auth.botService - auth service class providing authentification against a userlist
    • otfbot.services.control.botService - allows to control the behaviour of the bot during runtime
    • otfbot.services.ircClient.botService - No class docstring; 0/5 instance variable, 0/1 class variable, 3/5 methods documented
    • otfbot.services.ircServer.botService - botService spawning MYTCPServer instances using Server as protocol
    • otfbot.services.remoteCliServer.botService - This Service should open a port where either a Telnet- or a SSH-Service is listing.
    • otfbot.services.scheduler.botService - Wrapper class for the scheduling functions of twisted.internet.reactor.ReactorTime
    • otfbot.services.tcpServer.botService - No class docstring; 0/5 instance variable, 0/1 class variable, 1/2 method documented
    • otfbot.services.webServer.botService - Undocumented
    • otfbot.services.xmppClient.botService - xmpp botService
    • otfbot_plugin.MyMultiService - Undocumented
  • twisted.application.service.Service
    • otfbot.services.config.configService - No class docstring; 0/6 instance variable, 6/17 methods documented
  • twisted.conch.avatar.ConchUser
    • otfbot.services.remoteCliServer.SSHAvatar - Undocumented
  • twisted.conch.recvline.RecvLine
    • otfbot.services.remoteCliServer.remoteCLI - No class docstring; 0/1 instance variable, 3/3 methods documented
  • twisted.cred.portal.Portal
    • otfbot.services.auth.botService - auth service class providing authentification against a userlist
  • twisted.internet.protocol.ReconnectingClientFactory
    • otfbot.services.amqp.AmqpFactory - No class docstring; 0/15 instance variable, 2/6 methods documented
    • otfbot.services.ircClient.BotFactory - The Factory for the Bot
  • twisted.internet.protocol.ServerFactory
    • otfbot.services.ircServer.ircServerFactory - Factory building Server instaces, used by twisted
    • otfbot.services.tcpServer.tcpServerFactory - Factory for the tcpServer
  • twisted.protocols.basic.LineOnlyReceiver
    • otfbot.services.tcpServer.Server - This is a very simple LineOnlyReceiver. It only supports the callback lineReceived.
  • twisted.python.usage.Options
    • genconfig_plugin.Options - Undocumented
    • otfbot_plugin.Options - Undocumented
  • twisted.python.versions.Version
    • otfbot.lib.version.GitVersion - No class docstring; 1/3 method documented
  • twisted.web.resource.Resource
    • otfbot.services.webServer.Root - Undocumented
  • twisted.words.protocols.irc.IRCClient
    • otfbot.services.ircClient.Bot - The Protocol of our IRC-Bot
  • twisted.words.service.InMemoryWordsRealm
    • otfbot.services.auth.YamlWordsRealm - No class docstring; 0/3 instance variable, 0/1 class variable, 5/9 methods documented
  • twisted.words.service.IRCUser
    • otfbot.services.ircServer.Server - the server protocol, implemending pluginSupport and IRCUser
  • twisted.words.service.User
    • otfbot.lib.user.BotUser - represents a user of the bot
  • txamqp.protocol.AMQClient
    • otfbot.services.amqp.AmqpProtocol - The protocol is created and destroyed each time a connection is created and lost.
  • unittest.TestCase
    • otfbot.plugins.ircClient.jc.game.gameTestCase - Undocumented
    • otfbot.plugins.ircClient.jc.game.helpersTestCase - Undocumented
    • otfbot.plugins.ircClient.jc.game.LostTestCase - Undocumented
    • otfbot.plugins.ircClient.jc.game.userTestCase - Undocumented
  • wokkel.xmppim.MessageProtocol
    • otfbot.services.xmppClient.myMessageProtocol - Undocumented
  • wokkel.xmppim.PresenceClientProtocol
    • otfbot.services.xmppClient.myPresenceClientProtocol - Undocumented
  • wokkel.xmppim.RosterClientProtocol
    • otfbot.services.xmppClient.myRosterClientProtocol - Undocumented
API Documentation for OtfBot, generated by pydoctor 22.9.1 at 2025-06-01 02:00:01.