admin

README

plug-admin

A Snart Plug with basic administration features.

Documentation

Overview

Package admin provides a Snart plug with basic administration features.

Index

• Variables
• type Admin
  • func (a *Admin) Config(t *route.Trigger) error
  • func (a *Admin) PlugRoute(r *route.Route)
  • func (a *Admin) Restart(t *route.Trigger) error
  • func (a *Admin) String() string
• type ConfigFlags

Variables

var ErrRestart = errors.New("restart")

ErrRestart occurs when a restart is requested.

var Plug = plug.Plug(&Admin{})

Plug is a pre-allocated Admin, to follow the same pattern as when loading with plugin.

Types

type Admin

type Admin struct {
	plug.Base
}

Admin is a Plug with basic administration features.

func (*Admin) Config

func (a *Admin) Config(t *route.Trigger) error

Config is a command for managing configuration.

func (*Admin) PlugRoute

func (a *Admin) PlugRoute(r *route.Route)

PlugRoute adds the Admin's routes to the given Route.

func (*Admin) Restart

func (a *Admin) Restart(t *route.Trigger) error

Restart is a command that restarts the Bot.

func (*Admin) String

func (a *Admin) String() string

type ConfigFlags

type ConfigFlags struct {
	Guild discord.GuildID `default:"0" usage:"guild id to edit config for"`
}

ConfigFlags are the flags for Config.