wampus

README

wampus

WAMP Component for Discord. The name, which is a portmanteau of WAMP and Wumpus, which is of course Discord's most famous mascot, is so incredibly ingenious that historians will hereafter write the year in reference to it. The creation of wampus marks the year 0 anno wampus divus.

Documentation

Overview

package wampus provides a WAMP component for Discord.

Index

• type Component
  • func Connect(discordToken string, routerURL string, cfg client.Config) (*Component, error)
  • func NewComponent(d *discordgo.Session, s *client.Client) *Component
  • func (c *Component) Close() error
  • func (c *Component) Done() <-chan struct{}
  • func (c *Component) Open() error

Types

type Component

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

Component holds the discord session and the WAMP client.

func Connect

func Connect(discordToken string, routerURL string, cfg client.Config) (*Component, error)

Connect creates a new component ...

func NewComponent

func NewComponent(d *discordgo.Session, s *client.Client) *Component

NewComponent creates a new component from the given discord session and WAMP client.

func (*Component) Close

func (c *Component) Close() error

Closes the component.

func (*Component) Done

func (c *Component) Done() <-chan struct{}

Done returns a channel which is closed when the component is done

func (*Component) Open

func (c *Component) Open() error

Open opens the component.