jake/bolt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 20 Wiki Activity

adding reaction support #2

Merged
jake merged 1 commits from feature/reactions into main 2025-07-09 20:11:13 +00:00
Conversation 0 Commits 1 Files Changed 4 +144 -52
4 changed files with 144 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
README.md
View File

@ -1,28 +1,49 @@
# bolt # bolt
The nuts and bolts of a Discord bots. Bolt is a wrapper for [discordgo](https://github.com/bwmarrin/discordgo) that provides very quick bootstrapping for simple Discord bots. The nuts-and-bolts of Discord bots. Bolt is a wrapper for [discordgo](https://github.com/bwmarrin/discordgo) that provides quick and easy bootstrapping for simple Discord bots.
## Usage ## Usage
### Token ### Token
Bolt requires a Discord bot token to run, the token must be set as an environment variable labeled "DISCORD_TOKEN" Bolt requires a Discord bot token to run, the token must be set as an environment variable labeled "DISCORD_TOKEN"
### Commands ### Commands
Commands are represented by the Command struct. Any roles in the Command struct can run the command, if the Roles field is empty anyone can run the command. Commands are represented by the command struct and contain all needed information for bolt to handle the command payload. Including the command timeout as well as the Roles allowed to run the command.
```go ```go
type Command struct { type Command struct {
Trigger string //command that triggers payload NOT including the indicator 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 be run again Timeout time.Duration //the amount of time before command can be run again
lastRun time.Time //timestamp of last command run lastRun time.Time //timestamp of last command run
Roles []string //roles that can use command, if none are set anyone can run the command Roles []string //roles that can use command, if none are set anyone can run
} }
``` ```
### Payload ### Payload
Payload functions are executed when a command is detected, if no errors are returned and the returned string is not empty, then the returned string is sent in reply to the command message. Payload functions are executed when a command is detected
```go ```go
type Payload func(msg Message) (string, error) type Payload func(msg Message) error
``` ```
Payload functions are given a Message argument containing the needed data for handling commands
```go
type Message struct {
Author string //username of message author
ID string //discord ID of message author
Words []string //words from message split on whitespace
Content string //entire message content
Channel string //message channel
Server string //message guild
Attachments []MessageAttachment //message attachments
}
```
The Message struct also exposes some methods to support replying to, or acknowledging command messages
```go
func (m *Message) React(emoji Reaction) error
```
The React method will react to the command message by adding the requested emoji as a reaction. Bolt comes with a few preset emoji's for easy handling but any valid emoji string can be passed.
```go
func (m *Message) Respond(res string) error
```
The Respond method will send the value of <b>res</b> in response to the command message.
### Example ### Example
```go ```go
@ -32,7 +53,6 @@ import (
"time" "time"
"code.jakeyoungdev.com/jake/bolt" "code.jakeyoungdev.com/jake/bolt"
_ "github.com/joho/godotenv/autoload"
) )
func main() { func main() {
@ -41,30 +61,37 @@ func main() {
b := bolt.New(bolt.WithLogLevel(bolt.LogLevelCmd)) b := bolt.New(bolt.WithLogLevel(bolt.LogLevelCmd))
b.AddCommands( b.AddCommands(
// .ping can be run at any time by anyone and will respond with 'pong' // basic ping pong command, .ping can be run at anytime by anyone and will reply "pong"
bolt.Command{ bolt.Command{
Trigger: "ping", Trigger: "ping",
Payload: func(msg bolt.Message) (string, error) { Payload: func(msg bolt.Message) error {
return "pong", nil //any strings returned will be sent in response to the Discord message return msg.Respond("pong")
}, },
}, },
// .time can be run every 25 seconds by anyone and will respond with 'yer' // .react will add a +1 reaction to the command message, .react can be run by anyone at any rate
bolt.Command{
Trigger: "react",
Payload: func(msg bolt.Message) error {
return msg.React(bolt.ReactionThumbsUp)
},
},
// .time responds with the current date/time, .time can be run once every 25 seconds by any role
bolt.Command{ bolt.Command{
Trigger: "time", Trigger: "time",
Payload: func(msg bolt.Message) (string, error) { Payload: func(msg bolt.Message) error {
return "yer", nil return msg.Respond(time.Now().String())
}, },
Timeout: time.Second * 25, Timeout: time.Second * 25,
}, },
// .role can be run every 10 seconds by anyone with the 'admin' role and will respond with 'hi' // .role command can be ran every 10 seconds by anyone with the admin role and will return the string "admin"
bolt.Command{ bolt.Command{
Trigger: "role", Trigger: "role",
Payload: func(msg bolt.Message) (string, error) { Payload: func(msg bolt.Message) error {
return "hi", nil return msg.Respond("admin")
}, },
Timeout: time.Second * 10, Timeout: time.Second * 10,
Roles: []string{"admin"}, Roles: []string{"admin"},
}, },
) )
//start is a blocking call that handles safe-shutdown, all configuration and setup should be done before calling Start() //start is a blocking call that handles safe-shutdown, all configuration and setup should be done before calling Start()

56
bolt.go
View File

@ -126,10 +126,10 @@ func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) {
return return
} }
//if there is no content it is likely an image or a GIF, updating message content for //if there is no content it is likely an image, gif, or sticker, updating message content for
//better logging and to avoid confusion //better logging and to avoid confusion
if len(msg.Content) == 0 { if len(msg.Content) == 0 {
msg.Content = "GIF/IMAGE" msg.Content = "[Embedded Content]"
} }
if b.logLvl == LogLevelAll { if b.logLvl == LogLevelAll {
@ -190,27 +190,43 @@ func (b *bolt) handleCommand(msg *dg.MessageCreate, s *dg.Session, server *dg.Gu
} }
} }
//run command payload plMsg := Message{
res, err := run.Payload(Message{ Author: msg.Author.Username,
Author: msg.Author.Username, ID: msg.Author.ID,
ID: msg.Author.ID, msgID: msg.ID,
Words: words, Words: words,
Content: msg.Content, Content: msg.Content,
Channel: channel.Name, Channel: channel.Name,
Server: server.Name, channelID: msg.ChannelID,
}) Server: server.Name,
serverID: server.ID,
if err != nil { sesh: b,
return err
} }
//if a reply is returned send back to Discord //check for file attachments
if res != "" { if len(msg.Attachments) > 0 {
reply := b.createReply(res, msg.ID, msg.ChannelID, msg.GuildID) var att []MessageAttachment
_, err := s.ChannelMessageSendComplex(msg.ChannelID, reply) for _, a := range msg.Attachments {
if err != nil { att = append(att, MessageAttachment{
return err ID: a.ID,
URL: a.URL,
ProxyURL: a.ProxyURL,
Filename: a.Filename,
ContentType: a.ContentType,
Width: a.Width,
Height: a.Height,
Size: a.Size,
DurationSecs: a.DurationSecs,
})
} }
plMsg.Attachments = att
}
//run command payload
err = run.Payload(plMsg)
if err != nil {
return err
} }
//update run time //update run time

16
command.go
View File

@ -1,6 +1,8 @@
package bolt package bolt
import "time" import (
"time"
)
// custom Discord commands // custom Discord commands
type Command struct { type Command struct {
@ -12,14 +14,4 @@ type Command struct {
} }
// command payload functions, any strings returned are sent as a response to the command // command payload functions, any strings returned are sent as a response to the command
type Payload func(msg Message) (string, error) type Payload func(msg Message) error
// message information passed to payload function
type Message struct {
Author string //username of message author
ID string //discord ID of message author
Words []string //words from message split on whitespace
Content string //entire message content
Channel string //message channel
Server string //message guild
}

57
message.go Normal file
View File

@ -0,0 +1,57 @@
package bolt
import "fmt"
//built-in Discord reactions
type Reaction string
const (
ReactionThumbsUp Reaction = ":+1:"
ReactionThumbsDown Reaction = ":-1:"
ReactionPointUp Reaction = ":point_up:"
ReactionPointDown Reaction = ":point_down:"
ReactionHotdog Reaction = ":hotdog:"
ReactionGiraffe Reaction = ":giraffe:"
ReactionWatermelon Reaction = ":watermelon:"
ReactionNoPedestrians Reaction = ":no_pedestrian:"
)
// information about attachments to messages
type MessageAttachment struct {
ID string
URL string
ProxyURL string
Filename string
ContentType string
Width int
Height int
Size int
DurationSecs float64
}
// represents a Discord message
type Message struct {
Author string //username of message author
ID string //discord ID of message author
msgID string //id string of message
Words []string //words from message split on whitespace
Content string //entire message content
Channel string //message channel
channelID string //id of channel message was sent in
Server string //message guild
serverID string //id of guild message was sent in
Attachments []MessageAttachment
sesh *bolt
}
// applies reaction to message
func (m *Message) React(emoji Reaction) error {
return m.sesh.MessageReactionAdd(m.channelID, m.msgID, fmt.Sprint(emoji))
}
// sends the value of res in response to the message
func (m *Message) Respond(res string) error {
rep := m.sesh.createReply(res, m.msgID, m.channelID, m.serverID)
_, err := m.sesh.ChannelMessageSendComplex(m.channelID, rep)
return err
}