Compare commits
7 Commits
Author | SHA1 | Date | |
---|---|---|---|
dc3ef04778 | |||
55b7a717f6 | |||
d9ff09da6b | |||
ca67dc71ca | |||
6ae84c0d5b | |||
381073dc39 | |||
dc25c6e3ec |
62
README.md
62
README.md
@@ -3,7 +3,67 @@
|
|||||||
Base Discord bot framework
|
Base Discord bot framework
|
||||||
|
|
||||||
## Introduction
|
## 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.
|
bolt is a wrapper for Discordgo to provide very quick and easy setup for simple Discord bots. The only code required to run bolt are 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: ".ping", ".time", and ".role" the "." character is the default command indicator but that can be changed using the WithIndicator option.
|
||||||
|
```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(
|
||||||
|
// .ping can be run at any time by anyone and will respond with 'pong'
|
||||||
|
bolt.Command{
|
||||||
|
Trigger: "ping",
|
||||||
|
Payload: func(msg bolt.Message) (res string, err error) {
|
||||||
|
return "pong", nil //any strings returned will be sent in response to the Discord message
|
||||||
|
},
|
||||||
|
},
|
||||||
|
// .time can be run every 25 seconds by anyone and will respond with 'yer'
|
||||||
|
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 and will respond with 'hi'
|
||||||
|
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
|
## 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.
|
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.
|
120
bolt.go
120
bolt.go
@@ -4,7 +4,10 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"log"
|
"log"
|
||||||
"os"
|
"os"
|
||||||
|
"os/signal"
|
||||||
|
"slices"
|
||||||
"strings"
|
"strings"
|
||||||
|
"syscall"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
dg "github.com/bwmarrin/discordgo"
|
dg "github.com/bwmarrin/discordgo"
|
||||||
@@ -13,13 +16,8 @@ import (
|
|||||||
const (
|
const (
|
||||||
TOKEN_ENV_VAR = "DISCORD_TOKEN" //label for token environment variable
|
TOKEN_ENV_VAR = "DISCORD_TOKEN" //label for token environment variable
|
||||||
|
|
||||||
// BOT_INTENTS = dg.IntentsAllWithoutPrivileged |
|
BOT_INTENTS = dg.IntentGuilds |
|
||||||
// dg.IntentGuildMembers |
|
dg.IntentGuildMembers |
|
||||||
// dg.IntentGuildPresences |
|
|
||||||
// dg.IntentMessageContent |
|
|
||||||
// dg.IntentsGuildMessages
|
|
||||||
|
|
||||||
BOT_INTENTS = dg.IntentGuildMembers |
|
|
||||||
dg.IntentGuildPresences |
|
dg.IntentGuildPresences |
|
||||||
dg.IntentMessageContent |
|
dg.IntentMessageContent |
|
||||||
dg.IntentsGuildMessages
|
dg.IntentsGuildMessages
|
||||||
@@ -29,14 +27,16 @@ const (
|
|||||||
type bolt struct {
|
type bolt struct {
|
||||||
*dg.Session //holds discordgo internals
|
*dg.Session //holds discordgo internals
|
||||||
Commands map[string]Command //maps trigger phrase to command struct for fast lookup
|
Commands map[string]Command //maps trigger phrase to command struct for fast lookup
|
||||||
|
indicator string //the indicator used to detect whether a message is a command
|
||||||
}
|
}
|
||||||
|
|
||||||
type Bolt interface {
|
type Bolt interface {
|
||||||
Start() error
|
Start() error
|
||||||
Stop() error
|
stop() error
|
||||||
AddCommands(cmd Command)
|
AddCommands(cmd Command)
|
||||||
messageHandler(s *dg.Session, msg *dg.MessageCreate)
|
messageHandler(s *dg.Session, msg *dg.MessageCreate)
|
||||||
createReply(content, message, channel, guild string) *dg.MessageSend
|
createReply(content, message, channel, guild string) *dg.MessageSend
|
||||||
|
getRemainingTimeout(timeout time.Time) string
|
||||||
}
|
}
|
||||||
|
|
||||||
// setup
|
// setup
|
||||||
@@ -49,30 +49,53 @@ func init() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// create a new bolt interface
|
// create a new bolt interface
|
||||||
func New() *bolt {
|
func New(opts ...Option) *bolt {
|
||||||
bot, err := dg.New(fmt.Sprintf("Bot %s", os.Getenv(TOKEN_ENV_VAR)))
|
bot, err := dg.New(fmt.Sprintf("Bot %s", os.Getenv(TOKEN_ENV_VAR)))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Fatal(err)
|
log.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
bot.Identify.Intents = BOT_INTENTS
|
bot.Identify.Intents = BOT_INTENTS
|
||||||
|
|
||||||
return &bolt{
|
b := &bolt{
|
||||||
Session: bot,
|
Session: bot,
|
||||||
Commands: make(map[string]Command, 0),
|
Commands: make(map[string]Command, 0),
|
||||||
}
|
}
|
||||||
|
//set default command indicator
|
||||||
|
b.indicator = "."
|
||||||
|
|
||||||
|
for _, o := range opts {
|
||||||
|
o(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
return b
|
||||||
}
|
}
|
||||||
|
|
||||||
// adds command handler and starts the bot
|
// adds command handler and starts the bot, this is a BLOCKING CALL
|
||||||
|
|
||||||
|
// starts the bot, commands are added and the connection to Discord is opened, this is a BLOCKING
|
||||||
|
// call and handles safe shutdown of the bot
|
||||||
func (b *bolt) Start() error {
|
func (b *bolt) Start() error {
|
||||||
//register commands and open connection
|
//register commands and open connection
|
||||||
b.AddHandler(b.messageHandler)
|
b.AddHandler(b.messageHandler)
|
||||||
|
|
||||||
return b.Open()
|
err := b.Open()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
sigChannel := make(chan os.Signal, 1)
|
||||||
|
signal.Notify(sigChannel, syscall.SIGINT)
|
||||||
|
<-sigChannel
|
||||||
|
|
||||||
|
if err := b.stop(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// stops the bot
|
// stops the bot
|
||||||
func (b *bolt) Stop() error {
|
func (b *bolt) stop() error {
|
||||||
return b.Close()
|
return b.Close()
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -111,25 +134,55 @@ func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
//does the message have the command indicator "."
|
//does the message have the command indicator
|
||||||
if msg.Content[:1] == "." {
|
lg := len(b.indicator)
|
||||||
|
if msg.Content[:lg] == b.indicator {
|
||||||
words := strings.Split(msg.Content, " ")
|
words := strings.Split(msg.Content, " ")
|
||||||
run, ok := b.Commands[words[0]]
|
run, ok := b.Commands[words[0][lg:]]
|
||||||
if !ok {
|
if !ok {
|
||||||
return //command doesn't exist, maybe log or respond to author
|
return //command doesn't exist, maybe log or respond to author
|
||||||
}
|
}
|
||||||
|
|
||||||
//has command met its timeout requirements
|
//has command met its timeout requirements
|
||||||
if !time.Now().After(run.LastRun.Add(run.Timeout)) {
|
wait := run.LastRun.Add(run.Timeout)
|
||||||
return //running too soon, maybe respond letting know time remaining
|
if !time.Now().After(wait) {
|
||||||
|
reply := b.createReply(fmt.Sprintf("that command cannot be run for another %s", b.getRemainingTimeout(wait)), msg.ID, msg.ChannelID, msg.GuildID)
|
||||||
|
_, err := s.ChannelMessageSendComplex(msg.ChannelID, reply)
|
||||||
|
if err != nil {
|
||||||
|
log.Println(err)
|
||||||
|
}
|
||||||
|
return //running too soon
|
||||||
|
}
|
||||||
|
|
||||||
|
//does user have correct permissions
|
||||||
|
if run.Roles != nil {
|
||||||
|
var found bool
|
||||||
|
for _, r := range msg.Member.Roles {
|
||||||
|
n, err := s.State.Role(msg.GuildID, r)
|
||||||
|
if err != nil {
|
||||||
|
log.Println(err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
check := slices.Contains(run.Roles, n.Name)
|
||||||
|
if check {
|
||||||
|
found = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
//can't find role, don't run command
|
||||||
|
if !found {
|
||||||
|
reply := b.createReply("you do not have permissions to run that command", msg.ID, msg.ChannelID, msg.GuildID)
|
||||||
|
_, err := s.ChannelMessageSendComplex(msg.ChannelID, reply)
|
||||||
|
if err != nil {
|
||||||
|
log.Println(err)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
//run command payload
|
//run command payload
|
||||||
res, err := run.Payload(Message{
|
res, err := run.Payload(Message{
|
||||||
Author: Author{
|
Author: msg.Author.Username,
|
||||||
Username: msg.Author.Username,
|
|
||||||
Roles: msg.Member.Roles,
|
|
||||||
},
|
|
||||||
Words: words,
|
Words: words,
|
||||||
Message: msg.Content,
|
Message: msg.Content,
|
||||||
Channel: channel.Name,
|
Channel: channel.Name,
|
||||||
@@ -170,3 +223,24 @@ func (b *bolt) createReply(content, message, channel, guild string) *dg.MessageS
|
|||||||
Reference: details,
|
Reference: details,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// used to calculate the remaining time left in a timeout and returning it in a human-readable format
|
||||||
|
func (b *bolt) getRemainingTimeout(timeout time.Time) string {
|
||||||
|
r := time.Until(timeout)
|
||||||
|
var (
|
||||||
|
timeLeft int
|
||||||
|
metric string
|
||||||
|
)
|
||||||
|
timeLeft = int(r.Hours())
|
||||||
|
metric = "h"
|
||||||
|
if timeLeft < 1 {
|
||||||
|
timeLeft = int(r.Minutes())
|
||||||
|
metric = "m"
|
||||||
|
if timeLeft < 1 {
|
||||||
|
timeLeft = int(r.Seconds())
|
||||||
|
metric = "s"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf("%d%s", timeLeft, metric)
|
||||||
|
}
|
||||||
|
10
command.go
10
command.go
@@ -3,7 +3,7 @@ package bolt
|
|||||||
import "time"
|
import "time"
|
||||||
|
|
||||||
type Command struct {
|
type Command struct {
|
||||||
Trigger string //.command that triggers payload INCLUDING the '.'
|
Trigger string //command that triggers payload NOT including the indicator
|
||||||
Payload Payload //payload function to run when a command is detected
|
Payload Payload //payload function to run when a command is detected
|
||||||
Timeout time.Duration //the amount of time before command can run again
|
Timeout time.Duration //the amount of time before command can run again
|
||||||
LastRun time.Time //timestamp of last command run
|
LastRun time.Time //timestamp of last command run
|
||||||
@@ -16,15 +16,9 @@ type Payload func(msg Message) (res string, err error)
|
|||||||
|
|
||||||
// contains the basic information needed for a message command
|
// contains the basic information needed for a message command
|
||||||
type Message struct {
|
type Message struct {
|
||||||
Author Author
|
Author string //username of message author
|
||||||
Words []string //words from message split on whitespace
|
Words []string //words from message split on whitespace
|
||||||
Message string //entire message content
|
Message string //entire message content
|
||||||
Channel string //channel message was sent in
|
Channel string //channel message was sent in
|
||||||
Server string //guild message was sent in
|
Server string //guild message was sent in
|
||||||
}
|
}
|
||||||
|
|
||||||
// username and roles of message authors
|
|
||||||
type Author struct {
|
|
||||||
Username string
|
|
||||||
Roles []string
|
|
||||||
}
|
|
||||||
|
Reference in New Issue
Block a user