botbuilder

README

botbuilder

An extension for discordgo to create a Discord bot quickly using the Builder pattern.

Documentation

Overview

Package botbuilder allows for simple Discord bot initialization utilizing the builder pattern. The Discord API functionality is provided by a well-known package discorsessiono.

Index

• type BotBuilder
  • func NewBotBuilder(token string) *BotBuilder
  • func (bb *BotBuilder) AddCommand(command Command) *BotBuilder
  • func (bb *BotBuilder) AddCommands(commands ...Command) *BotBuilder
  • func (bb *BotBuilder) AddEventHandler(eventHandler func(*discordgo.Session, interface{})) *BotBuilder
  • func (bb *BotBuilder) AddEventHandlers(eventHandlers ...func(*discordgo.Session, interface{})) *BotBuilder
  • func (bb *BotBuilder) AddSlashCommand(slashCommand *SlashCommand) *BotBuilder
  • func (bb *BotBuilder) AddSlashCommands(slashCommands ...*SlashCommand) *BotBuilder
  • func (bb *BotBuilder) Build() (*discordgo.Session, error)
  • func (bb *BotBuilder) SetIntents(intents discordgo.Intent) *BotBuilder
  • func (bb *BotBuilder) SetMessageCollector(collector []*discordgo.MessageCreate) *BotBuilder
  • func (bb *BotBuilder) SetPrefix(prefix string) *BotBuilder
• type BotData
  • func (b BotData) Build() (*discordgo.Session, error)
• type Command
• type SlashCommand
• type Subcommand

Types

type BotBuilder

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

BotBuilder represents a Discord bot builder.

func NewBotBuilder

func NewBotBuilder(token string) *BotBuilder

NewBotBuilder creates a new BotBuilder object and writes the token specified into the builder. You don't have to add "Bot " to the token like in discorsessiono as the builder will do it for you.

func (*BotBuilder) AddCommand

func (bb *BotBuilder) AddCommand(command Command) *BotBuilder

AddCommand adds a single command to the bot.

func (*BotBuilder) AddCommands

func (bb *BotBuilder) AddCommands(commands ...Command) *BotBuilder

AddCommands adds multiple commands to the bot.

func (*BotBuilder) AddEventHandler

func (bb *BotBuilder) AddEventHandler(eventHandler func(*discordgo.Session, interface{})) *BotBuilder

AddEventHandler adds a single Discord event handler to the bot.

func (*BotBuilder) AddEventHandlers

func (bb *BotBuilder) AddEventHandlers(eventHandlers ...func(*discordgo.Session, interface{})) *BotBuilder

AddEventHandlers adds multiple Discord event handlers to the bot.

func (*BotBuilder) AddSlashCommand

func (bb *BotBuilder) AddSlashCommand(slashCommand *SlashCommand) *BotBuilder

AddSlashCommand adds a single slash command to the bot.

func (*BotBuilder) AddSlashCommands

func (bb *BotBuilder) AddSlashCommands(slashCommands ...*SlashCommand) *BotBuilder

AddSlashCommands adds multiple slash commands to the bot.

func (*BotBuilder) Build

func (bb *BotBuilder) Build() (*discordgo.Session, error)

Build creates a Discord bot, adding the command handler and event handlers specified.

func (*BotBuilder) SetIntents

func (bb *BotBuilder) SetIntents(intents discordgo.Intent) *BotBuilder

SetIntents sets the bot's intents. If not called, the bot's intents will be set to IntentsGuildMessages.

func (*BotBuilder) SetMessageCollector

func (bb *BotBuilder) SetMessageCollector(collector []*discordgo.MessageCreate) *BotBuilder

SetMessageBuffer sets a message collector for the bot. Every time a MessageCreate event is invoked the event data is passed into c.

func (*BotBuilder) SetPrefix

func (bb *BotBuilder) SetPrefix(prefix string) *BotBuilder

SetPrefix sets a prefix for the bot. By default, there is no prefix.

type BotData

type BotData struct {
	Token            string
	Prefix           string
	Commands         []Command
	Intents          discordgo.Intent
	EventHandlers    []func(*discordgo.Session, interface{})
	MessageCollector []*discordgo.MessageCreate
}

BotData represents Discord bot data and provides another way of using botbuilder. Default intents are IntentsGuildMessages.

func (BotData) Build

func (b BotData) Build() (*discordgo.Session, error)

Builds the Discord session.

type Command

type Command struct {
	Name        string
	Description string
	Aliases     []string
	Subcommands []Subcommand
	Execute     func(*discordgo.Session, *discordgo.MessageCreate, []string)
}

Command represents a Discord command.

type SlashCommand

type SlashCommand struct {
	ApplicationCommand *discordgo.ApplicationCommand
	Execute            func(session *discordgo.Session, event *discordgo.InteractionCreate)
	Guild              string
}

type Subcommand

type Subcommand struct {
	Name           string
	Description    string
	Aliases        []string
	ExecuteCommand bool
	Execute        func(*discordgo.Session, *discordgo.MessageCreate, []string)
}

Subcommand represents a Discord subcommand.