twitch_chat_bot

package module

v0.0.0-...-1a60180 Latest Latest Go to latest Published: Jan 23, 2023 License: MIT Imports: 9 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

Repository

github.com/StkngEsk/twitch_chat_bot

README ¶

twitch_chat_bot

An app to connect with chat by channel twitch

Documentation ¶

Constants ¶

View Source

const PSTFormat = "Jan 2 15:04:05 PST"

Variables ¶

This section is empty.

Functions ¶

func TimeStamp ¶

func TimeStamp(format string) string

the generic variation, for bots using the TwitchBot interface

Types ¶

type BasicBot ¶

type BasicBot struct {
	Channel string

	MsgRate    time.Duration
	Name       string
	Port       string
	OAuthToken string
	Server     string
	// contains filtered or unexported fields
}

func (*BasicBot) Connect ¶

func (bb *BasicBot) Connect()

Connects the bot to the Twitch IRC server. The bot will continue to try to connect until it succeeds or is manually shutdown.

func (*BasicBot) Disconnect ¶

func (bb *BasicBot) Disconnect()

Officially disconnects the bot from the Twitch IRC server.

func (*BasicBot) HandleChat ¶

func (bb *BasicBot) HandleChat() error

Listens for and logs messages from chat. Responds to commands from the channel owner. The bot continues until it gets disconnected, told to shutdown, or forcefully shutdown.

func (*BasicBot) JoinChannel ¶

func (bb *BasicBot) JoinChannel()

Makes the bot join its pre-specified channel.

func (*BasicBot) Say ¶

func (bb *BasicBot) Say(msg string) error

Makes the bot send a message to the chat channel.

func (*BasicBot) Start ¶

func (bb *BasicBot) Start()

Starts a loop where the bot will attempt to connect to the Twitch IRC server, then connect to the pre-specified channel, and then handle the chat. It will attempt to reconnect until it is told to shut down, or is forcefully shutdown.

type TwitchBot ¶

type TwitchBot interface {
	Connect()
	Disconnect()
	HandleChat() error
	JoinChannel()
	Say(msg string) error
	Start()
}

Source Files ¶

View all Source files

twitch_chat_bot.go

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