oodle

Documentation

Index

• Variables
• func SetDefaults()
• type Bot
• type Checker
• type Command
• type Deps
• type IRCClient
• type Join
• type Leave
• type Message
• type Sender
• type Trigger

Variables

var Commit = ""

var ErrUsage = errors.New("Wrong command usage")

var Version = ""

Functions

func SetDefaults

func SetDefaults()

Types

type Bot

type Bot interface {
	RegisterCommands(plugins ...Command)
	RegisterTriggers(plugins ...Trigger)
	Commands() []Command
}

Bot handles trigger/command execution

type Checker

type Checker interface {
	IsRegistered(nick string) bool
	InChannel(nick string) bool
	IsAdmin(nick string) bool
}

type Command

type Command struct {
	Prefix      string
	Name        string
	Description string
	Usage       string
	Fn          func(nick string, args []string) (reply string, err error)
}

type Deps

type Deps struct {
	IRC    IRCClient
	Bot    Bot
	DB     *sql.DB
	Logger *logrus.Logger
}

Deps is a container for common dependencies

type IRCClient

type IRCClient interface {
	Connect() error
	Close()
	OnEvent(callback func(event interface{}))
	Sender
	Checker
}

IRCClient is a simplified client given to plugins.

type Join

type Join struct {
	Nick string
}

type Leave

type Leave struct {
	Nick string
}

type Message

type Message struct {
	Nick string
	Msg  string
}

Simpified IRC events

type Sender

type Sender interface {
	Send(message string)
	SendTo(user, message string)
	Sendf(format string, a ...interface{})
}

type Trigger

type Trigger func(event interface{})

Trigger is a basic event handler