help

README

plug-help

A Snart Plug which provides a basic help menu.

Documentation

Overview

Package help is a Snart plug which provides a basic help menu.

Index

• Variables
• type Help
  • func (h *Help) About(t *route.Trigger) error
  • func (h *Help) Menu(t *route.Trigger) error
  • func (h *Help) PlugRoute(r *route.Route)
  • func (h *Help) String() string
• type MenuFlags

Variables

var (
	// NumCPU returns the number of processors on the system. Exported only for testing.
	NumCPU = runtime.NumCPU

	// TotalRAM returns the amount of RAM available on the system. Exported only for testing.
	TotalRAM = memory.TotalMemory

	// AllocRAM returns the amount of RAM allocated to the runtime. Exported only for testing.
	AllocRAM = func() uint64 {
		ms := runtime.MemStats{}
		runtime.ReadMemStats(&ms)

		return ms.Sys
	}
)

var Plug = plug.Plug(&Help{
	Startup: time.Now(),
})

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

Types

type Help

type Help struct {
	plug.Base

	Startup time.Time
}

Help provides basic help and info menus.

func (*Help) About

func (h *Help) About(t *route.Trigger) error

About gives statistics about the given Bot.

func (*Help) Menu

func (h *Help) Menu(t *route.Trigger) error

Menu gives a help menu.

func (*Help) PlugRoute

func (h *Help) PlugRoute(r *route.Route)

PlugRoute adds the Help's Commands to the given Route.

func (*Help) String

func (h *Help) String() string

type MenuFlags

type MenuFlags struct {
	Help bool `default:"false" usage:"helpception"`
}

MenuFlags is flags for Menu.