gumi

README

gumi

DiscordGo command framework

Documentation

Index

• Variables
• type Argument
  • 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
  • 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
• type Ctx
  • 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
• type RateLimiter
  • 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
  • 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)
• type Storage
  • 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{})

Variables

var (
	// RegexUserMention defines the regex a user mention has to match
	RegexUserMention = regexp.MustCompile("<@!?(\\d+)>")

	// RegexRoleMention defines the regex a role mention has to match
	RegexRoleMention = regexp.MustCompile("<@&(\\d+)>")

	// RegexChannelMention defines the regex a channel mention has to match
	RegexChannelMention = regexp.MustCompile("<#(\\d+)>")
)

Types

type Argument

type Argument struct {
	Raw string
}

Argument represents a single argument

func (*Argument) AsBool

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

AsBool parses the given argument into a boolean

func (*Argument) AsChannelMentionID

func (argument *Argument) AsChannelMentionID() string

AsChannelMentionID returns the ID of the mentioned channel or an empty string if it is no mention

func (*Argument) AsInt

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

AsInt parses the given argument into an int32

func (*Argument) AsInt64

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

AsInt64 parses the given argument into an int64

func (*Argument) AsRoleMentionID

func (argument *Argument) AsRoleMentionID() string

AsRoleMentionID returns the ID of the mentioned role or an empty string if it is no mention

func (*Argument) AsUserMentionID

func (argument *Argument) AsUserMentionID() string

AsUserMentionID returns the ID of the mentioned user or an empty string if it is no mention

type Arguments

type Arguments struct {
	Raw       string
	Arguments []*Argument
}

Arguments represents arguments used in a command.

func ParseArguments

func ParseArguments(raw string) *Arguments

func (*Arguments) AsSingle

func (arguments *Arguments) AsSingle() *Argument

AsSingle parses the given arguments as a single one

func (*Arguments) Get

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

Get returns the n'th argument

func (*Arguments) Len

func (arguments *Arguments) Len() int

Len returns the length of the arguments

func (*Arguments) Remove

func (arguments *Arguments) Remove(n int)

Remove removes the n'th argument

type Command

type Command struct {
	Name        string
	Group       string
	Aliases     []string
	Description string
	Usage       string
	Example     string
	Flags       map[string]string
	GuildOnly   bool
	NSFW        bool
	AuthorOnly  bool
	Permissions int64
	RateLimiter *RateLimiter
	Exec        ExecutionHandler
}

type Ctx

type Ctx struct {
	Session *discordgo.Session
	Event   *discordgo.MessageCreate
	Args    *Arguments
	Router  *Router
	Command *Command
}

func (*Ctx) Reply

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

Reply responds with the given text message

func (*Ctx) ReplyEmbed

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

ReplyEmbed responds with the given embed message

func (*Ctx) ReplyTextEmbed

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

ReplyTextEmbed responds with the given text and embed message

type ExecutionHandler

type ExecutionHandler func(*Ctx) error

ExecutionHandler represents a handler for a context execution

type RateLimiter

type RateLimiter struct {
	Cooldown time.Duration
	// contains filtered or unexported fields
}

func NewRateLimiter

func NewRateLimiter(cooldown time.Duration) *RateLimiter

func (*RateLimiter) Contains

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

func (*RateLimiter) Expires

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

func (*RateLimiter) Set

func (r *RateLimiter) Set(key string)

type Router

type Router struct {
	Commands                map[string]*Command
	CaseSensitive           bool
	AuthorID                string
	Storage                 *Storage
	PrefixResolver          func(*discordgo.Session, *discordgo.MessageCreate) []string
	NotCommandCallback      func(*Ctx) error
	OnErrorCallback         func(*Ctx, error)
	OnRateLimitCallback     func(*Ctx) error
	OnNoPermissionsCallback func(*Ctx) error
	OnNSFWCallback          func(*Ctx) error
	OnExecuteCallback       func(*Ctx) error
	OnPanicCallBack         func(ctx *Ctx, recover interface{})
}

func Create

func Create(r *Router) *Router

func (*Router) Handler

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

func (*Router) Initialize

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

func (*Router) RegisterCmd

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

type Storage

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

Storage wraps a map[string]interface to provide thread safe access endpoints.

func (*Storage) Delete

func (s *Storage) Delete(key string)

Delete removes a key-value pair from the map.

func (*Storage) Get

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

Get tries to get a value from the map.

func (*Storage) MustGet

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

MustGet wraps Get but only returns the value, if found, or nil otherwise.

func (*Storage) Set

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

Set sets a value to the map by key.