bot

package

v0.0.0-...-3f13264 Latest Latest Go to latest Published: Mar 25, 2024 License: MIT Imports: 41 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 Bot struct {
	// contains filtered or unexported fields
}

Bot is a Discord bot account.

func New(token string, opts ...Option) (*Bot, error)

New creates a new Bot.

func (b *Bot) Start(ctx context.Context) error

Start opens a connection to Discord and enables the internal image cache's automatic deletion.

type Option func(*Bot)

Option configures a Bot.

func WithAdmins(admins ...discord.UserID) Option

WithAdmins adds one or more admins to the Bot.

func WithDB(db *sql.DB) Option

WithDB sets a Bot's DB.

func WithDebug(debug bool) Option

WithDebug toggles debug mode on a Bot.

func WithFeedbackWebhook(hook *webhook.Client) Option

WithFeedbackWebhook sets the Bot's feedback webhook.

func WithLogger(l *zap.Logger) Option

WithLogger sets a Bot's logger.

func WithLoggingWebhook(hook *webhook.Client) Option

WithLoggingWebhook sets the Bot's error log webhook.

func WithSiteAddr(site string) Option

WithSiteAddr sets a Bot's site address.

func WithSteamAPIKey(key string) Option

WithSteamAPIKey sets a Bot's Steam API key.

func WithTopsterAddr(t string) Option

WithTopsterAddr sets the Bot's address for a Topster microservice.