127 lines
3.8 KiB
Markdown
127 lines
3.8 KiB
Markdown
# bolt
|
|
|
|
TODO
|
|
pre-1. Break up msg handler method its insane
|
|
pre-2. Copy main into README
|
|
1. Read through code and ensure I didn't miss anything
|
|
2. do research on intents for 'admin' jobs
|
|
3. comments and README updates, things have changed
|
|
4. determine adjustments to timeouts and contexts and const vs options for it
|
|
5. Figure out why the exiting printing is going after terminal exit
|
|
|
|
---
|
|
|
|
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 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
|
|
}
|
|
```
|
|
|
|
### Payload
|
|
Payload functions are executed when a command is detected
|
|
```go
|
|
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.
|
|
```go
|
|
func Delete() error
|
|
```
|
|
The Delete method will delete the message from the text channel
|
|
|
|
### Example
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"strings"
|
|
"time"
|
|
|
|
"code.jakeyoungdev.com/jake/bolt"
|
|
_ "github.com/joho/godotenv/autoload"
|
|
)
|
|
|
|
func main() {
|
|
b, err := bolt.New(bolt.WithLogLevel(bolt.LogLevelAll),
|
|
bolt.WithMaxGoroutines(150),
|
|
bolt.WithPermissions(bolt.MessagePermissions, bolt.AdminPermissions))
|
|
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
b.AddCommands(
|
|
bolt.Command{
|
|
Trigger: "test",
|
|
Payload: func(msg *bolt.Message, admin bolt.AdminToolBox) error {
|
|
return msg.Respond("hi")
|
|
},
|
|
},
|
|
bolt.Command{
|
|
Trigger: "timeout",
|
|
Payload: func(msg *bolt.Message, tools bolt.AdminToolBox) error {
|
|
if len(msg.Mentions) > 0 {
|
|
err := tools.Timeout(msg.Mentions[0].ID, msg.ServerID, time.Now().Add(time.Minute*5))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return msg.Respond("done")
|
|
},
|
|
Roles: []string{"admin"},
|
|
},
|
|
)
|
|
|
|
b.AddMessageHandler(func(msg *bolt.Message, tools bolt.AdminToolBox) error {
|
|
if strings.Contains(msg.Content, "swear word") {
|
|
return tools.Timeout(msg.Author.ID, msg.ServerID, time.Now().Add(time.Hour*1))
|
|
}
|
|
|
|
if msg.Content == "im a menace in VC" {
|
|
return tools.Mute(msg.Author.ID, msg.ServerID)
|
|
}
|
|
return nil
|
|
})
|
|
|
|
err = b.Start()
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
|
|
|
|
```
|
|
|
|
## Development
|
|
bolt is in development at the moment and may break occasionally before a v1 release |