irc

Documentation

Overview

Package irc provides a lightning.Plugin implementation for IRC. To use IRC support with lightning, see New

bot := lightning.NewBot(...)

bot.AddPluginType("irc", irc.New)

bot.UsePluginType("irc", "irc", map[string]string{
	// ...
})

Index

• func New(cfg map[string]string, data lightning.PluginDataStorage) (lightning.Plugin, error)

Functions

func New

func New(cfg map[string]string, data lightning.PluginDataStorage) (lightning.Plugin, error)

New creates a new lightning.Plugin that provides IRC support for Lightning

It only takes in a map with the following structure:

	map[string]string{
		"server": "irc.libera.chat:6697", // your IRC server (required)
		"tls":    "true", // whether to use TLS (optional, defaults to false)
 		"nick":   "lightning", // your IRC nickname (required)
		"set_bot": "true", // whether to set the bot mode flag (+B, optional, defaults to false)
		"sasl_user": "lightning", // a username for SASL auth (optional, must be paired with sasl_pass)
		"sasl_pass": "lightning", // a password for SASL auth (optional, must be paired with sasl_user)
		"timeout":      "2", // message/sec limit preventing autokilling (optional, defaults to 2)
		"connect_cmds": "...", // commands to run on connect (optional, used to login with NickServ)
	}