bolt/README.md

# bolt

Base Discord bot framework

## Introduction
bolt is a wrapper for Discordgo to provide very quick and easy setup for simple Discord bots. The only code required to run bolt is the command handler functions, this provides developers with the ability to have text-based commands on a Discord server without all the bootstrapping and setup usually required. Any strings returned from the Payload function will be sent back to the Discord server as a reply to the command message.

## Basic Usage
bolt allows developers to create a Discord bot with simply a discord bot token and a few lines of Go code, the below example creates a Discord bot and registers three commands: ".test", ".time", and ".role"
```go
package main

import (
	"log"
	"os"
	"os/signal"
	"syscall"
	"time"

	"code.jakeyoungdev.com/jake/bolt"
	_ "github.com/joho/godotenv/autoload"
)

func main() {
	b := bolt.New()

	b.AddCommands(
        // .test can be run at any time by anyone
		bolt.Command{
			Trigger: ".test",
			Payload: func(msg bolt.Message) (res string, err error) {
				return "nah", nil //any strings returned will be sent in response to the Discord message
			},
		},
        // .time can be run every 25 seconds by anyone
		bolt.Command{
			Trigger: ".time",
			Payload: func(msg bolt.Message) (res string, err error) {
				return "yer", nil
			},
			Timeout: time.Second * 25,
		},
        // .role can be run every 10 seconds by anyone with the 'admin' role
        bolt.Command{
            Trigger: ".role",
            Payload: func(msg bolt.Message) (res string, err error) {
				return "hi", nil
			},
            Timeout: time.Second * 10,
            Roles: []string{"admin"},
        },
	)

	_ = b.Start()

	//set up safe CTRL-C
	sigChannel := make(chan os.Signal, 1)
	signal.Notify(sigChannel, syscall.SIGINT)
	log.Println("bot running")
	<-sigChannel

	if err := b.Stop(); err != nil {
		panic(err)
	}
}
```

## Development
bolt is in heavy development at the moment and may break occasionally before a v1 release, it is currently in a testing phase and should not be used until tagged.