commandrouter

commandrouter

About

This repository is a part of projectdoll, which is developed by lukasl-dev.

This repository uses the following dependencies:

• github.com/lukasl-dev/gotilities
• github.com/andersfylling/disgord
• github.com/lukasl-dev/gommandparser

Getting started

It is assumed that you have already worked with the Go environment. If this is not the case, see this page first.

Installation

Installation with go get

go get -u github.com/projectdoll/commandrouter

Import

Standalone Import

import "github.com/projectdoll/commandrouter"

Multiple Import

import (
    "github.com/projectdoll/commandrouter"
)

Usage

Create a Router

Create a simple Router

router, err := commandrouter.Simple(PREFIXES...)

Create a Router from Options

router, err := commandrouter.New(commandrouter.Options{
    PrefixGenerator: func(session disgord.Session, message *disgord.Message) ([]string, error) {
        return PREFIXES..., nil
    },
    ...
})

Create a Command

Here the command is returned after the execution of the function Then and is simultaneously registered and can be used.

cmd := router.On(LABELS...).Then(func(ctx commandrouter.Context) error {
    panic("implement me")
})

or

An implemented version of a command is created and then registered. After registration the command can be used.

cmd := &commandrouter.CMD{
    Names: []string{LABELS...},
    Actions: []commandrouter.CommandFunc{
        func(ctx commandrouter.Context) error {
            panic("implement me")
        },
    },
    ...
}
router.Append(cmd)

Full example

/* create a Router */
 router, err := commandrouter.Simple("!")

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

/* create a disgord.Client and connect */
bot := disgord.New(disgord.Config{BotToken: TOKEN})
defer bot.StayConnectedUntilInterrupted(context.Background())

/* register handlers */
bot.On(disgord.EvtMessageCreate, router.HandlerMessageCreate)
bot.On(disgord.EvtMessageUpdate, router.HandlerMessageUpdate)

/* create ping command */
router.On("ping").Then(func(ctx commandrouter.Context) error {
    _, _ = ctx.Respond(context.Background(), &disgord.CreateMessageParams{Content: "PONG!"})
    return nil
})