Services — Module to provide nick and channel services

Services enables the bot to:

• Set it’s nick on startup, and fall back to other names if one nick is taken
• Identify with nickserv or similar
• Ghost users using it’s nick
• Request invites & join private channels

Config

{
    "user":{
        "nick":[
            "pyircbot3",
            "pyircbot3_",
            "pyircbot3__"
        ],
        "password":"nickservpassword",
        "username":"pyircbot3",
        "hostname":"pyircbot3.domain.com",
        "realname":"pyircbot3"
    },
    "ident":{
        "enable":"no",
        "to":"nickserv",
        "command":"identify %(password)s",
        "ghost":"no",
        "ghost_to":"nickserv",
        "ghost_cmd":"ghost %(nick)s %(password)s"
    },
    "channels":[
        "#xmopx"
    ],
    "privatechannels":{
        "to":"chanserv",
        "command":"invite %(channel)s",
        "list":[
            "#aprivatechannel"
        ]
    }
}

user.nick

A list of nicks, the first being the preferred nick and the others being fallbacks if the primary nick is taken.

user.password

Nickserv password

user.username

IRC username

user.hostname

Host name for the USER command

user.realname

IRC real name

ident.enable

Yes/no if you want to identify with Nickserv or another nick-protection entity

ident.to

Nick the identify command will be sent to

ident.command

String formatted command to be sent for identification. Available tokens:

• password

ident.ghost

Yes/no if the bot should attempt to ghost anyone using it’s nickname

ident.ghost_to

Nick the ghost command will be sent to

ident.ghostcmd

String formatted command to be sent for ghosting. Available tokens:

• nick
• password

channels

List of channels to join on startup

privatechannels.to

Nick to send the invite command to

privatechannels.command

String formatted command to be sent for invitations. Available tokens:

• channel

privatechannels.list

List of channels to request an invite to join on startup

Service

The service service provides information about the state of IRC. Available service methods:

nick()

Returns the current nick of the bot

Class Reference

class pyircbot.modules.Services.Services(bot, moduleName)

Bases: pyircbot.modulebase.ModuleBase

channels()

nick()