From 286294bab9dee1d6e0eae59e69d661995ce1cc6f Mon Sep 17 00:00:00 2001 From: jake Date: Tue, 8 Jul 2025 15:52:25 -0400 Subject: [PATCH] adding reaction support - some rework of structure to allow for more puposeful response usage - react and response now live on the message itself - message structs split into own file - readme updated to use new methods --- README.md | 67 ++++++++++++++++++++++++++++++++++++++---------------- bolt.go | 56 +++++++++++++++++++++++++++++---------------- command.go | 16 ++++--------- message.go | 57 ++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 144 insertions(+), 52 deletions(-) create mode 100644 message.go diff --git a/README.md b/README.md index 8ec5051..544ae2e 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,49 @@ # 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 ### Token Bolt requires a Discord bot token to run, the token must be set as an environment variable labeled "DISCORD_TOKEN" ### 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 type Command struct { Trigger string //command that triggers payload NOT including the indicator Payload Payload //payload function to run when a command is detected Timeout time.Duration //the amount of time before command can be run again 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 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 -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 res in response to the command message. ### Example ```go @@ -32,7 +53,6 @@ import ( "time" "code.jakeyoungdev.com/jake/bolt" - _ "github.com/joho/godotenv/autoload" ) func main() { @@ -41,30 +61,37 @@ func main() { b := bolt.New(bolt.WithLogLevel(bolt.LogLevelCmd)) 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{ Trigger: "ping", - Payload: func(msg bolt.Message) (string, error) { - return "pong", nil //any strings returned will be sent in response to the Discord message + Payload: func(msg bolt.Message) error { + 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{ Trigger: "time", - Payload: func(msg bolt.Message) (string, error) { - return "yer", nil + Payload: func(msg bolt.Message) error { + return msg.Respond(time.Now().String()) }, 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) (string, error) { - return "hi", nil + // .role command can be ran every 10 seconds by anyone with the admin role and will return the string "admin" + bolt.Command{ + Trigger: "role", + Payload: func(msg bolt.Message) error { + return msg.Respond("admin") }, - Timeout: time.Second * 10, - Roles: []string{"admin"}, - }, + Timeout: time.Second * 10, + Roles: []string{"admin"}, + }, ) //start is a blocking call that handles safe-shutdown, all configuration and setup should be done before calling Start() diff --git a/bolt.go b/bolt.go index 5416231..81309fd 100644 --- a/bolt.go +++ b/bolt.go @@ -126,10 +126,10 @@ func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) { 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 if len(msg.Content) == 0 { - msg.Content = "GIF/IMAGE" + msg.Content = "[Embedded Content]" } if b.logLvl == LogLevelAll { @@ -190,27 +190,43 @@ func (b *bolt) handleCommand(msg *dg.MessageCreate, s *dg.Session, server *dg.Gu } } - //run command payload - res, err := run.Payload(Message{ - Author: msg.Author.Username, - ID: msg.Author.ID, - Words: words, - Content: msg.Content, - Channel: channel.Name, - Server: server.Name, - }) - - if err != nil { - return err + plMsg := Message{ + Author: msg.Author.Username, + ID: msg.Author.ID, + msgID: msg.ID, + Words: words, + Content: msg.Content, + Channel: channel.Name, + channelID: msg.ChannelID, + Server: server.Name, + serverID: server.ID, + sesh: b, } - //if a reply is returned send back to Discord - if res != "" { - reply := b.createReply(res, msg.ID, msg.ChannelID, msg.GuildID) - _, err := s.ChannelMessageSendComplex(msg.ChannelID, reply) - if err != nil { - return err + //check for file attachments + if len(msg.Attachments) > 0 { + var att []MessageAttachment + for _, a := range msg.Attachments { + att = append(att, MessageAttachment{ + 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 diff --git a/command.go b/command.go index aa35cf7..a14a70d 100644 --- a/command.go +++ b/command.go @@ -1,6 +1,8 @@ package bolt -import "time" +import ( + "time" +) // custom Discord commands type Command struct { @@ -12,14 +14,4 @@ type Command struct { } // command payload functions, any strings returned are sent as a response to the command -type Payload func(msg Message) (string, 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 -} +type Payload func(msg Message) error diff --git a/message.go b/message.go new file mode 100644 index 0000000..0859b06 --- /dev/null +++ b/message.go @@ -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 +} -- 2.47.2