irc

README

Joe Bot - IRC Adapter

IRC adapter. https://github.com/go-joe/joe

IRC adapter for: https://github.com/go-joe/joe

This simple IRC adapter forwards all messages directed to it on a particular channel to the brain. To direct a message to the bot, the IRC message needs to contain the bot's IRC nick prefixed with @ at the beginning, e.g. @thebot hello world makes the IRC adapter receive hello world. As the "channel", it uses the IRC nick of the user who sent the message. The "channel" will be used in responses to directly address the same user, in the form @user this is the response.

Example

cfg := irc.Config{
	Address: "my-irc-server.com:6667",
	Nick: "my-irc-bot",
	Name: "My IRC Bot",
	Channel: "#my-irc-channel",
}

b := &ExampleBot{
	Bot: joe.New("my-irc-bot", irc.Adapter(cfg),
}

Documentation

Index

• func Adapter(cfg Config) joe.Module
• type Config

Functions

func Adapter

func Adapter(cfg Config) joe.Module

Adapter accepts a Config object and returns a joe.Module that can then used when creating a new bot using joe.New.

Types

type Config

type Config struct {
	Address string
	Nick    string
	User    string
	Pass    string
	Name    string
	Channel string
}

Config contains all the IRC configuration that you need. Required fields are Address, Nick and Channel.