kuma

README

KumaEngine

Personal discordgo extend library

How to use

1. Installation

go get -u github.com/devproje/kuma-engine-v2

2. Example code

package main

import (
	"flag"
	"strconv"

	"github.com/bwmarrin/discordgo"
	"github.com/devproje/kuma-engine"
	"github.com/devproje/kuma-engine/v2/command"
	"github.com/devproje/kuma-engine/v2/utils"
	"github.com/devproje/plog/log"
)

var (
	token = *flag.String("token", "", "Type Discord Token")
)

func ready(session *discordgo.Session, ready *discordgo.Ready) {
	log.Infof("Logged in as %s", ready.User.String())
}

func main() {
	builder := kuma.EngineBuilder()
	builder.SetToken(token)
	builder.AddEventOnceListener(ready)
	builder.SetKumaInfo(true)

	err := builder.Build()
	if err != nil {
		log.Fatalln(err)
	}
}

Documentation

Index

• type Engine
  • func EngineBuilder() *Engine
  • func (k *Engine) AddCommand(command command.Executor)
  • func (k *Engine) AddCommandHandler(handler *command.Handler)
  • func (k *Engine) AddEventListener(ev interface{})
  • func (k *Engine) AddEventOnceListener(ev interface{})
  • func (k *Engine) AddLoggingFile(name string)
  • func (k *Engine) Build() error
  • func (k *Engine) Close() error
  • func (k *Engine) CreateInterruptSignal()
  • func (k *Engine) DropCommand(name string)
  • func (k *Engine) GetShard(shardId int) (*discordgo.Session, error)
  • func (k *Engine) GetShardCount() int
  • func (k *Engine) IsKumaInfo() bool
  • func (k *Engine) RemoveCommandHandler(handler *command.Handler)
  • func (k *Engine) SetIntent(intent discordgo.Intent)
  • func (k *Engine) SetKumaInfo(value bool)
  • func (k *Engine) SetMode(m mode.EngineMode)
  • func (k *Engine) SetShardCount(shardCount int)
  • func (k *Engine) SetToken(token string)

Types

type Engine

type Engine struct {
	Token   string
	Session *discordgo.Session
	// contains filtered or unexported fields
}

func EngineBuilder

func EngineBuilder() *Engine

EngineBuilder Create a new Engine instance

func (*Engine) AddCommand

func (k *Engine) AddCommand(command command.Executor)

AddCommand Add a new command in inner handler

func (*Engine) AddCommandHandler

func (k *Engine) AddCommandHandler(handler *command.Handler)

AddCommandHandler Add a new command handler

func (*Engine) AddEventListener

func (k *Engine) AddEventListener(ev interface{})

AddEventListener Add a new event listener

func (*Engine) AddEventOnceListener

func (k *Engine) AddEventOnceListener(ev interface{})

AddEventOnceListener Add a new event listener once

func (*Engine) AddLoggingFile

func (k *Engine) AddLoggingFile(name string)

AddLoggingFile Add a new logging file

func (*Engine) Build

func (k *Engine) Build() error

Build Building the bot session

func (*Engine) Close

func (k *Engine) Close() error

Close Closing bot session

func (*Engine) CreateInterruptSignal

func (k *Engine) CreateInterruptSignal()

CreateInterruptSignal Create an interrupt signal

func (*Engine) DropCommand

func (k *Engine) DropCommand(name string)

DropCommand Remove a command in inner handler

func (*Engine) GetShard

func (k *Engine) GetShard(shardId int) (*discordgo.Session, error)

func (*Engine) GetShardCount

func (k *Engine) GetShardCount() int

GetShardCount Get the bot shard count

func (*Engine) IsKumaInfo

func (k *Engine) IsKumaInfo() bool

IsKumaInfo Check if the kuma info command is enabled

func (*Engine) RemoveCommandHandler

func (k *Engine) RemoveCommandHandler(handler *command.Handler)

RemoveCommandHandler Remove a command handler

func (*Engine) SetIntent

func (k *Engine) SetIntent(intent discordgo.Intent)

SetIntent Set the bot intents

func (*Engine) SetKumaInfo

func (k *Engine) SetKumaInfo(value bool)

SetKumaInfo Set the kuma info command

func (*Engine) SetMode

func (k *Engine) SetMode(m mode.EngineMode)

SetMode Set the engine mode

func (*Engine) SetShardCount

func (k *Engine) SetShardCount(shardCount int)

SetShardCount Set the bot shard count

func (*Engine) SetToken

func (k *Engine) SetToken(token string)

SetToken Set the bot token