stdcommands

README

Standard Commands

Standard Commands is a space to store and develop the different commands of the bot, which will be used by the users with the prefix provided to the application.

Make a Command

The commands are stored in a folder that represents a single package, then these packages must be imported into the stdcommands.go file. Stdcommands load the different commands when the bot is started.

Each command is imported as a variable containing a WafferCommand struct, provided by the commands package located at ./pkg/plugins/commands/commands.go.

Example

package ping

import (
	"fmt"

	"github.com/bwmarrin/discordgo"
	"github.com/nicolito128/waffer/pkg/plugins"
	"github.com/nicolito128/waffer/pkg/plugins/commands"
)

var Command = &commands.WafferCommand{
	Plugin: &plugins.Plugin[*discordgo.MessageCreate]{
		Name:    "ping",
		Type:    plugins.MessageCreateType,
		Handler: Handler,
	},

	Data: &commands.CommandData{
		Name:        "ping",
		Description: "Ping!",
		Permissions: &commands.CommandPermissions{
			AllowDM: true,
			Require: discordgo.PermissionSendMessages,
		},
	},
}

func Handler(s *discordgo.Session, m *discordgo.MessageCreate) {
	s.ChannelMessageSend(m.ChannelID, "Pong!")
}

Documentation

Index

• func Checker[T any](s *discordgo.Session, t T, mid ...Middleware[T]) error
• func Command(s *discordgo.Session, m *discordgo.MessageCreate)
• func CommandChecker(s *discordgo.Session, t *discordgo.MessageCreate, cmd *commands.WafferCommand, ...) error
• func ExecuteInteraction(s *discordgo.Session, i *discordgo.InteractionCreate)
• func LoadCommands(s *discordgo.Session)
• func LoadInteraction(s *discordgo.Session, g *discordgo.GuildCreate)
• type CommandMiddleware
• type Middleware

Functions

func Checker

func Checker[T any](s *discordgo.Session, t T, mid ...Middleware[T]) error

func Command

func Command(s *discordgo.Session, m *discordgo.MessageCreate)

func CommandChecker

func CommandChecker(s *discordgo.Session, t *discordgo.MessageCreate, cmd *commands.WafferCommand, mid ...CommandMiddleware) error

func ExecuteInteraction

func ExecuteInteraction(s *discordgo.Session, i *discordgo.InteractionCreate)

func LoadCommands

func LoadCommands(s *discordgo.Session)

func LoadInteraction

func LoadInteraction(s *discordgo.Session, g *discordgo.GuildCreate)

Types

type CommandMiddleware

type CommandMiddleware func(s *discordgo.Session, t *discordgo.MessageCreate, c *commands.WafferCommand) bool

type Middleware

type Middleware[T any] func(s *discordgo.Session, t T) bool