better naming standards

- safe shutdown handled in library

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 jake
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -3,10 +3,10 @@
 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.
+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: ".test", ".time", and ".role"
+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
 
@@ -25,24 +25,24 @@ func main() {
 	b := bolt.New()
 
 	b.AddCommands(
-        // .test can be run at any time by anyone
+        // .ping can be run at any time by anyone and will respond with 'pong'
 		bolt.Command{
-			Trigger: ".test",
+			Trigger: "ping",
 			Payload: func(msg bolt.Message) (res string, err error) {
-				return "nah", nil //any strings returned will be sent in response to the Discord message
+				return "pong", nil //any strings returned will be sent in response to the Discord message
 			},
 		},
-        // .time can be run every 25 seconds by anyone
+        // .time can be run every 25 seconds by anyone and will respond with 'yer'
 		bolt.Command{
-			Trigger: ".time",
+			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
+        // .role can be run every 10 seconds by anyone with the 'admin' role and will respond with 'hi'
         bolt.Command{
-            Trigger: ".role",
+            Trigger: "role",
             Payload: func(msg bolt.Message) (res string, err error) {
 				return "hi", nil
 			},
@@ -51,15 +51,9 @@ func main() {
         },
 	)
 
-	_ = b.Start()
+	//start is a blocking call that handles safe-shutdown, all configuration and setup should be done before calling Start()
-
+	err := b.Start()
-	//set up safe CTRL-C
+	if err != nil {
-	sigChannel := make(chan os.Signal, 1)
-	signal.Notify(sigChannel, syscall.SIGINT)
-	log.Println("bot running")
-	<-sigChannel
-
-	if err := b.Stop(); err != nil {
 		panic(err)
 	}
 }

bolt.go

@@ -4,8 +4,10 @@ import (
 	"fmt"
 	"log"
 	"os"
+	"os/signal"
 	"slices"
 	"strings"
+	"syscall"
 	"time"
 
 	dg "github.com/bwmarrin/discordgo"
@@ -25,11 +27,12 @@ const (
 type bolt struct {
 	*dg.Session                    //holds discordgo internals
 	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 {
 	Start() error
-	Stop() error
+	stop() error
 	AddCommands(cmd Command)
 	messageHandler(s *dg.Session, msg *dg.MessageCreate)
 	createReply(content, message, channel, guild string) *dg.MessageSend
@@ -46,30 +49,53 @@ func init() {
 }
 
 // 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)))
 	if err != nil {
 		log.Fatal(err)
 	}
-
 	bot.Identify.Intents = BOT_INTENTS
 
-	return &bolt{
+	b := &bolt{
 		Session:  bot,
 		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 {
 	//register commands and open connection
 	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
-func (b *bolt) Stop() error {
+func (b *bolt) stop() error {
 	return b.Close()
 }
 
@@ -108,10 +134,11 @@ func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) {
 		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, " ")
-		run, ok := b.Commands[words[0]]
+		run, ok := b.Commands[words[0][lg:]]
 		if !ok {
 			return //command doesn't exist, maybe log or respond to author
 		}
@@ -157,7 +184,7 @@ func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) {
 		res, err := run.Payload(Message{
 			Author:  msg.Author.Username,
 			Words:   words,
-			Message: msg.Content,
+			Content: msg.Content,
 			Channel: channel.Name,
 			Server:  server.Name,
 		})

command.go

@@ -3,7 +3,7 @@ package bolt
 import "time"
 
 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
 	Timeout time.Duration //the amount of time before command can run again
 	LastRun time.Time     //timestamp of last command run
@@ -18,7 +18,7 @@ type Payload func(msg Message) (res string, err error)
 type Message struct {
 	Author  string   //username of message author
 	Words   []string //words from message split on whitespace
-	Message string   //entire message content
+	Content string   //entire message content
 	Channel string   //channel message was sent in
 	Server  string   //guild message was sent in
 }

option.go

@@ -0,0 +1,10 @@
+package bolt
+
+type Option func(b *bolt)
+
+// sets the substring that must be present at the beginning of the message to indicate a command
+func WithIndicator(i string) Option {
+	return func(b *bolt) {
+		b.indicator = i
+	}
+}