ircbot

package

v0.2.6 Latest Latest Go to latest Published: Feb 16, 2023 License: GPL-3.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type CommandAction func(
	map[string]string,
	*hbot.Message,
	*IrcBot,
) bool

type IrcBot struct {
	// contains filtered or unexported fields
}

This is the entrypoint for ircbot.

func Init(configFile string) (*IrcBot, error)

Initializes the bot. Pass it a configfile and you'll have in return a functioning instance of an IRC bot.

func (irc *IrcBot) AddBuiltins(showHelp bool)

func (irc *IrcBot) AddCommand(name string, action CommandAction) *triggers.Command

Adds a non-configured command to the registry, that can be then configured.

func (irc *IrcBot) Close() error

Disconnects the bot.

func (irc *IrcBot) Config() *bot.Configuration

Returns the configuration

func (irc *IrcBot) DB() *sql.DB

Returns the database handle. Useful in commands.

func (irc *IrcBot) Logger() log.Logger

get the hellabot logger

func (irc *IrcBot) Msg(who, what string)

Send a message to a user or channel

func (irc *IrcBot) RegisterCommands(commands []*triggers.Command) error

func (irc *IrcBot) Reply(m *hbot.Message, what string)

Reply to a message via IRC

func (irc *IrcBot) Run()

func (irc *IrcBot) Topic(channel string, what string)

Change topic