snart

README

Snart

A Discord bot framework in Go. Currently still a little janky, but feel free to use it if you know what you're doing!

Documentation

Overview

Package snart contains the general workings of a Snart Bot.

Index

• Constants
• type Bot
  • func New(c confy.Confy) (*Bot, error)
  • func (b *Bot) CycleGamers()
  • func (b *Bot) Plug(p Plug) error
  • func (b *Bot) Run() error
• type Gamer
• type GamerFunc
  • func (f GamerFunc) Activity() discord.Activity
• type GamerStatic
  • func (s GamerStatic) Activity() discord.Activity
• type GamerTimer
  • func (t GamerTimer) Activity() discord.Activity
• type Plug

Constants

const BaseIntents = gateway.IntentGuildMessages

BaseIntents is the basic intents needed by a Bot.

const KeyToken = "token"

KeyToken is the Confy key used to fetch the Bot's token.

Types

type Bot

type Bot struct {
	*route.Route

	Intents gateway.Intents
	Gamers  []Gamer
	Errs    chan error
}

Bot holds all the workings of a Snart bot.

func New

func New(c confy.Confy) (*Bot, error)

New creates a Bot with the given token.

func (*Bot) CycleGamers

func (b *Bot) CycleGamers()

CycleGamers continually updates the Bot's status using a random Gamer, on an interval.

func (*Bot) Plug

func (b *Bot) Plug(p Plug) error

Plug applies the given Plug to the Bot.

func (*Bot) Run

func (b *Bot) Run() error

Run performs the Bot's startup functions, and waits for an error.

type Gamer

type Gamer interface {
	Activity() discord.Activity
}

Gamer generates an Activity.

type GamerFunc

type GamerFunc func() discord.Activity

GamerFunc is a func that is a Gamer.

func (GamerFunc) Activity

func (f GamerFunc) Activity() discord.Activity

Activity simply calls the GamerFunc and returns the returned Activity.

type GamerStatic

type GamerStatic discord.Activity

GamerStatic is an Activity that is a Gamer.

func (GamerStatic) Activity

func (s GamerStatic) Activity() discord.Activity

Activity simply returns the GamerStatic as an Activity.

type GamerTimer

type GamerTimer time.Time

GamerTimer is a Time that is a Gamer.

func (GamerTimer) Activity

func (t GamerTimer) Activity() discord.Activity

Activity returns an Activity that describes the duration since the GamerTimer.

type Plug

type Plug interface {
	fmt.Stringer

	Plug(*Bot) error
}

Plug describes a plugin for a Bot.