kuma

README

KumaEngine

Personal discordgo extend library

How to use

1. Installation

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

2. Example code

package main

import (
	"flag"
	"strconv"

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

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

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

func main() {
	flag.Parse()
	var err error
	engine := &kuma.Engine{
		Token: token,
		Color: 0xFF0000,
	}
	engine, err = engine.Create()
	if err != nil {
		plog.Fatalln(err)
	}
	
	engine.AddEventOnce(ready)

	err = engine.Start()
	if err != nil {
		log.Fatalln(err)
	}

	e = engine
	log.Infoln("Bot is now running. Press CTRL-C to exit.")
	engine.CreateInterruptSignal()

	err = engine.Stop()
	if err != nil {
		log.Fatalln(err)
	}
}

Documentation

Index

• Constants
• type Engine
  • func (k *Engine) AddAct(a *discordgo.Activity)
  • func (k *Engine) AddActs(a ...*discordgo.Activity)
  • func (k *Engine) AddEvent(event interface{}) func()
  • func (k *Engine) AddEventOnce(event interface{}) func()
  • func (k *Engine) AddLoggingFile(name string)
  • func (k *Engine) Create() (*Engine, error)
  • func (k *Engine) CreateIntents(intent discordgo.Intent) (*Engine, error)
  • func (k *Engine) CreateInterruptSignal()
  • func (k *Engine) DisableKumaInfo()
  • func (k *Engine) GetActDelay() int
  • func (k *Engine) InitActs()
  • func (k *Engine) SetAct(a *discordgo.Activity)
  • func (k *Engine) SetActDelay(second int)
  • func (k *Engine) SetActs(a ...*discordgo.Activity)
  • func (k *Engine) Start() error
  • func (k *Engine) Stop() error
  • func (k *Engine) Version() string

Constants

const KUMA_ENGINE_VERSION = "v1.5.1"

Types

type Engine

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

func (*Engine) AddAct

func (k *Engine) AddAct(a *discordgo.Activity)

AddAct add one activity

func (*Engine) AddActs

func (k *Engine) AddActs(a ...*discordgo.Activity)

AddActs add many activities

func (*Engine) AddEvent

func (k *Engine) AddEvent(event interface{}) func()

AddEvent Add discord event handler

func (*Engine) AddEventOnce

func (k *Engine) AddEventOnce(event interface{}) func()

AddEventOnce Add discord event handler once

func (*Engine) AddLoggingFile

func (k *Engine) AddLoggingFile(name string)

func (*Engine) Create

func (k *Engine) Create() (*Engine, error)

Create default engine

func (*Engine) CreateIntents

func (k *Engine) CreateIntents(intent discordgo.Intent) (*Engine, error)

CreateIntents create engine with discord intents

func (*Engine) CreateInterruptSignal

func (k *Engine) CreateInterruptSignal()

CreateInterruptSignal Creating Ctrl+C interrupt signal

func (*Engine) DisableKumaInfo

func (k *Engine) DisableKumaInfo()

DisableKumaInfo Disable kumainfo command

func (*Engine) GetActDelay

func (k *Engine) GetActDelay() int

GetActDelay Get activity change time

func (*Engine) InitActs

func (k *Engine) InitActs()

InitActs Initializing activity array

func (*Engine) SetAct

func (k *Engine) SetAct(a *discordgo.Activity)

SetAct set activity

func (*Engine) SetActDelay

func (k *Engine) SetActDelay(second int)

SetActDelay Set activity change time

func (*Engine) SetActs

func (k *Engine) SetActs(a ...*discordgo.Activity)

SetActs set activities

func (*Engine) Start

func (k *Engine) Start() error

Start starting engine

func (*Engine) Stop

func (k *Engine) Stop() error

Stop stopped engine

func (*Engine) Version

func (k *Engine) Version() string

Version Checking engine version