gumi

May 21, 2021

Changes in this version

type Router

+ OnPanicCallBack func(ctx *Ctx, recover interface{})

Feb 13, 2021

Changes in this version

type Command

+ AuthorOnly bool

type Router

+ AuthorID string

+ Storage *Storage

+ type Storage struct

+ func (s *Storage) Delete(key string)

+ func (s *Storage) Get(key string) (interface{}, bool)

+ func (s *Storage) MustGet(key string) interface{}

+ func (s *Storage) Set(key string, val interface{})

Jan 27, 2021

Changes in this version

type Command

+ Flags map[string]string

Jan 27, 2021

Changes in this version

+ var RegexChannelMention = regexp.MustCompile("<#(\\d+)>")

+ var RegexRoleMention = regexp.MustCompile("<@&(\\d+)>")

+ var RegexUserMention = regexp.MustCompile("<@!?(\\d+)>")

+ type Argument struct

+ Raw string

+ func (argument *Argument) AsBool() (bool, error)

+ func (argument *Argument) AsChannelMentionID() string

+ func (argument *Argument) AsInt() (int, error)

+ func (argument *Argument) AsInt64() (int64, error)

+ func (argument *Argument) AsRoleMentionID() string

+ func (argument *Argument) AsUserMentionID() string

+ type Arguments struct

+ Arguments []*Argument

+ Raw string

+ func ParseArguments(raw string) *Arguments

+ func (arguments *Arguments) AsSingle() *Argument

+ func (arguments *Arguments) Get(n int) *Argument

+ func (arguments *Arguments) Len() int

+ func (arguments *Arguments) Remove(n int)

type Command

+ Example string

+ Group string

+ Permissions int

+ RateLimiter *RateLimiter

+ Usage string

+ type Ctx struct

+ Args *Arguments

+ Command *Command

+ Event *discordgo.MessageCreate

+ Router *Router

+ Session *discordgo.Session

+ func (ctx *Ctx) Reply(text string) error

+ func (ctx *Ctx) ReplyEmbed(embed *discordgo.MessageEmbed) error

+ func (ctx *Ctx) ReplyTextEmbed(text string, embed *discordgo.MessageEmbed) error

+ type ExecutionHandler func(*Ctx) error

+ type RateLimiter struct

+ Cooldown time.Duration

+ func NewRateLimiter(cooldown time.Duration) *RateLimiter

+ func (r *RateLimiter) Contains(key string) bool

+ func (r *RateLimiter) Expires(key string) (time.Duration, error)

+ func (r *RateLimiter) Set(key string)

+ type Router struct

+ CaseSensitive bool

+ Commands map[string]*Command

+ NotCommandCallback func(*discordgo.Session, *discordgo.MessageCreate) error

+ OnErrorCallback func(*discordgo.Session, *discordgo.MessageCreate, error)

+ OnExecuteCallback func(*Ctx) error

+ OnNSFWCallback func(*Ctx) error

+ OnNoPermissionsCallback func(*Ctx) error

+ OnRateLimitCallback func(*Ctx) error

+ PrefixResolver func(*discordgo.Session, *discordgo.MessageCreate) []string

+ func Create(r *Router) *Router

+ func (r *Router) Handler() func(*discordgo.Session, *discordgo.MessageCreate)

+ func (r *Router) Initialize(session *discordgo.Session)

+ func (r *Router) RegisterCmd(command *Command)

Sep 10, 2020

Changes in this version

type Command

+ Cooldown time.Duration

type Group

+ func (g *Group) SetDescription(s string) *Group

+ func (g *Group) SetNSFW(v bool) *Group

Aug 2, 2020

Changes in this version

+ type Command struct

+ Aliases []string

+ Description string

+ Exec GumiExec

+ GuildOnly bool

+ Help *HelpSettings

+ NSFW bool

+ Name string

+ func NewCommand(name string, exec GumiExec, opts ...CommandOption) *Command

+ type CommandOption func(*Command)

+ func CommandDescription(desc string) CommandOption

+ func GuildOnly() CommandOption

+ func WithAliases(aliases ...string) CommandOption

+ func WithHelp(hs *HelpSettings) CommandOption

+ type ErrorHandler func(e error) *discordgo.MessageSend

+ type Group struct

+ Commands map[string]*Command

+ Description string

+ IsVisible bool

+ NSFW bool

+ Name string

+ func (g *Group) AddCommand(name string, exec GumiExec, opts ...CommandOption) *Command

+ type GroupOption func(*Group)

+ func GroupDescription(desc string) GroupOption

+ func GroupNSFW() GroupOption

+ type Gumi struct

+ DefaultPrefixes []string

+ ErrorHandler ErrorHandler

+ Groups map[string]*Group

+ HelpCommand HelpHandler

+ PrefixHandler PrefixResolver

+ func NewGumi(opts ...Option) *Gumi

+ func (g *Gumi) AddGroup(name string, opts ...GroupOption) *Group

+ func (g *Gumi) GeneralGroup() *Group

+ func (g *Gumi) Handle(s *discordgo.Session, m *discordgo.MessageCreate)

+ func (g *Gumi) SetErrorHandler(eh ErrorHandler) *Gumi

+ func (g *Gumi) SetHelpCommand(hc HelpHandler) *Gumi

+ func (g *Gumi) SetPrefixHandler(ph PrefixResolver) *Gumi

+ type GumiExec func(*discordgo.Session, *discordgo.MessageCreate, []string) error

+ type HelpHandler func(*Gumi, *discordgo.Session, *discordgo.MessageCreate, []string) *discordgo.MessageSend

+ type HelpSettings struct

+ ExtendedHelp []*discordgo.MessageEmbedField

+ IsVisible bool

+ func NewHelpSettings() *HelpSettings

+ func (hs *HelpSettings) AddField(name, value string, inline bool) *HelpSettings

+ type Option func(*Gumi)

+ func WithErrorHandler(eh ErrorHandler) Option

+ func WithHelpHandler(hh HelpHandler) Option

+ func WithPrefixResolver(pr PrefixResolver) Option

+ func WithPrefixes(prefixes ...string) Option

+ type PrefixResolver func(*Gumi, *discordgo.Session, *discordgo.MessageCreate) []string