anothi

README

* Anothi

Anothi is a command framework for [[https://github.com/bwmarrin/discordgo][discordgo]].

* Usage

#+BEGIN_SRC go
package main

import (
	"yab/commands"

	"github.com/bwmarrin/discordgo"
	"github.com/ratsclub/anothi"
)

var f = anothi.New()

func init() {
	f.Prefix("!").
		OnNotFound(commands.OnNotFound).
		OnError(commands.OnError).
		OnNoPermission(commands.OnNoPermission)

	f.AddCommand("del", commands.BanUser, discordgo.PermissionAdministrator)
	f.AddCommand("kick", commands.KickUser, discordgo.PermissionKickMembers)
	f.AddCommand("ban", commands.BanUser, discordgo.PermissionBanMembers)

	dg.AddHandler(f.OnMessageCreate)
}
#+END_SRC

Documentation

Index

• type Framework
  • func New() Framework
  • func (f *Framework) AddCommand(name string, fun callbackFunction, permission int)
  • func (f *Framework) OnError(fun fallbackFunction) *Framework
  • func (f *Framework) OnMessageCreate(s *discordgo.Session, m *discordgo.MessageCreate)
  • func (f *Framework) OnNoPermission(fun fallbackFunction) *Framework
  • func (f *Framework) OnNotFound(fun fallbackFunction) *Framework
  • func (f *Framework) Prefix(prefix string) *Framework

Types

type Framework

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

Framework determines all properties of your commands

func New

func New() Framework

New returns a new framework instance

func (*Framework) AddCommand

func (f *Framework) AddCommand(name string, fun callbackFunction, permission int)

AddCommand adds a new command

func (*Framework) OnError

func (f *Framework) OnError(fun fallbackFunction) *Framework

OnError will set a default function that will be called when a command raises an error

func (*Framework) OnMessageCreate

func (f *Framework) OnMessageCreate(s *discordgo.Session, m *discordgo.MessageCreate)

OnMessageCreate is the callback used to tie the framework with discordgo

func (*Framework) OnNoPermission

func (f *Framework) OnNoPermission(fun fallbackFunction) *Framework

OnNoPermission will set a default function that will be called when a user does not have permission for a command

func (*Framework) OnNotFound

func (f *Framework) OnNotFound(fun fallbackFunction) *Framework

OnNotFound will set a default function that will be called when a command doest not exist

func (*Framework) Prefix

func (f *Framework) Prefix(prefix string) *Framework

Prefix will set your bot prefix