gopherbot

command module
v0.0.0-...-0d01ef4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 17, 2015 License: BSD-1-Clause Imports: 20 Imported by: 0

README

ircb

ircb is an IRC bot. In its bare form, it does not do much besides connecting to a server and joining the appropriate channels. In order to make it useful, commands have to be registered to allow users to interact with it.

A bot can be configured through an external .ini file. For an example of one, refer to the config.example.ini file in the root of this repo.

Dependencies

go get github.com/jteeuwen/ini

Usage

go get github.com/jteeuwen/ircb

The bot is launched with the -p flag. This flag expects an existing directory path, contianing the bot profile, as well as any optional plugin configurations. Its directory structure is as follows:

[$path]
   |
   |- [plugins]
   |    |
   |    |- [foo]
   |    |    |- config.ini
   |    |
   |    |- [bar]
   |    |    |- config.ini
   |
   |- config.ini

For example:

$ ircb -p ~/.ircb/someprofile

License

Unless otherwise stated, all of the work in this project is subject to a 1-clause BSD license. Its contents can be found in the enclosed LICENSE file.

Documentation

Overview

ircb is an IRC bot.

Directories

Path Synopsis
This package holds bot command parsing and execution code.
This package holds bot command parsing and execution code.
This package contains some basic IRC related types.
This package contains some basic IRC related types.
This package contains basic network code for a TCP client.
This package contains basic network code for a TCP client.
This package contains some plugin related utility functions.
This package contains some plugin related utility functions.
plugins
admin
This plugin offers a rudimentary set of administrative commands for the bot.
This plugin offers a rudimentary set of administrative commands for the bot.
dict
Package dict implements the Dictionary Server Protocol as defined in RFC 2229.
Package dict implements the Dictionary Server Protocol as defined in RFC 2229.
ipintel
This plugin provides geolocation information for IP addresses.
This plugin provides geolocation information for IP addresses.
url
This plugin detects webpage urls embedded in incoming messages.
This plugin detects webpage urls embedded in incoming messages.
weather
This plugin provides weather report services.
This plugin provides weather report services.
This package holds an IRC client protocol implementation.
This package holds an IRC client protocol implementation.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL