The highest tagged major version is v2.

bot

package

v0.21.0 Latest Latest Go to latest Published: Sep 19, 2021 License: BSD-3-Clause Imports: 6 Imported by: 10

Details

Package bot provides a basic embeddable Bot struct for more easily handling commands

This section is empty.

This section is empty.

This section is empty.

type Bot struct {
	Router *bcr.Router

	Modules []Module
}

Bot is the main bot struct

func New(token string) (*Bot, error)

New creates a new instance of Bot. The token will be prefixed with `Bot ` automatically.

func NewWithRouter(r *bcr.Router) *Bot

NewWithRouter creates a new bot with the given router

func (bot *Bot) Add(f func(*Bot) (string, []*bcr.Command))

Add adds a module to the bot

func (bot *Bot) CommandList(ctx *bcr.Context) (err error)

CommandList is a command that shows a list of all commands in the bot instance

func (bot *Bot) Owner(owners ...discord.UserID)

Owner is a helper function to set the bot's owner(s)

func (bot *Bot) Prefix(prefixes ...string)

Prefix is a helper function to set the bot's router's prefixes

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

Start wraps around Router.ShardManager.Open()

type Module interface {
	String() string
	Commands() []*bcr.Command
}

Module is a single module/category of commands