gerbil

README

gerbil

gerbil is a high level wrapper around DiscordGo designed to make the creation of Discord bots much faster.

Usage

package main

import "github.com/jamiecorrigan/gerbil"

func main() {
	config := gerbil.Config{
		name: "Ping Bot",
		token: "ENV:PING_BOT_TOKEN", // Using ENV: at the start will cause gerbil to look at env vars.
		prefix: "!",
	}
	bot := gerbil.NewBot(&config)
	bot.Start() // handles cleanup when an INT is retrieved.
}

Documentation

Index

• func ResolveConfigString(s string) (string, bool)
• type Bot
  • func NewBot(c *Config) *Bot
  • func (b *Bot) ReplyToMessage(m *discordgo.Message, msg string)
  • func (b *Bot) Run()
  • func (b *Bot) SendMessage(cid string, msg string)
• type Command
  • func (c *Command) Run(b *Bot, s *discordgo.Session, m *discordgo.MessageCreate, argString string)
• type CommandArg
• type CommandInput
• type Config
  • func (c *Config) Parse() []error
• type Event
• type EventScheduler
  • func NewEventScheduler(sendFunc func(string, string), e []Event) *EventScheduler
  • func (e *EventScheduler) Start()
  • func (e *EventScheduler) Stop()
• type Logger
  • func NewLogger(session *discordgo.Session, loggingChannelID string) *Logger
  • func (l *Logger) Error(err error)
  • func (l *Logger) Output(s string)

Functions

func ResolveConfigString

func ResolveConfigString(s string) (string, bool)

ResolveConfigString resolves the value of a configuration string.

Types

type Bot

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

Bot represents ALL of the state of the bot.

func NewBot

func NewBot(c *Config) *Bot

NewBot constructs a new bot.

func (*Bot) ReplyToMessage

func (b *Bot) ReplyToMessage(m *discordgo.Message, msg string)

ReplyToMessage reoplies to a message.

func (*Bot) Run

func (b *Bot) Run()

Run starts up the bot. This operation is blocking and cleanups after receiving a kill instruction.

func (*Bot) SendMessage

func (b *Bot) SendMessage(cid string, msg string)

SendMessage sends a message to a specific channel.

type Command

type Command struct {
	Name          string
	Aliases       []string
	Desc          string
	Op            func(ci CommandInput)
	Args          []CommandArg
	ApprovedRoles []string
}

Command represents a discord command.

func (*Command) Run

func (c *Command) Run(b *Bot, s *discordgo.Session, m *discordgo.MessageCreate, argString string)

Run a command.

type CommandArg

type CommandArg struct {
	Name    string
	Repeats bool
}

CommandArg represents an argument for a Command.

type CommandInput

type CommandInput struct {
	Bot     *Bot
	Session *discordgo.Session
	Message *discordgo.Message
	Args    map[string][]string
}

CommandInput represents the input to a command handler.

type Config

type Config struct {
	// public
	Name             string
	Token            string
	Commands         []Command
	Events           []Event
	EnableHelp       bool
	Prefix           string
	LoggingChannelID string
	// contains filtered or unexported fields
}

Config represents the configuration options for a bot.

func (*Config) Parse

func (c *Config) Parse() []error

Parse checks a config for errors and performs any transforms or setup required.

type Event

type Event struct {
	Message   string
	Exp       string
	ChannelID string
}

Event represents a scheduled CRON event.

type EventScheduler

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

EventScheduler represents the scheduler for CRON events.

func NewEventScheduler

func NewEventScheduler(sendFunc func(string, string), e []Event) *EventScheduler

NewEventScheduler constructs a new EventScheduler.

func (*EventScheduler) Start

func (e *EventScheduler) Start()

Start cron.

func (*EventScheduler) Stop

func (e *EventScheduler) Stop()

Stop cron.

type Logger

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

Logger represents an instance of a logger. If the bot is running and a logging channel is setup then the bot will log to that channel, otherwise it'll log to stdout.

func NewLogger

func NewLogger(session *discordgo.Session, loggingChannelID string) *Logger

NewLogger constructs a new Logger.

func (*Logger) Error

func (l *Logger) Error(err error)

Error logs an error.

func (*Logger) Output

func (l *Logger) Output(s string)

Output logs a message.