From 55b7a717f6e4a6d5e342c8133b2f681cbf9d108b Mon Sep 17 00:00:00 2001
From: jake <jake.young.dev@gmail.com>
Date: Wed, 4 Jun 2025 18:28:27 -0400
Subject: [PATCH] adding options

- ability to update indicator
---
 README.md  | 10 +++++-----
 bolt.go    | 21 +++++++++++++++------
 command.go |  2 +-
 option.go  | 10 ++++++++++
 4 files changed, 31 insertions(+), 12 deletions(-)
 create mode 100644 option.go

diff --git a/README.md b/README.md
index 3e764b5..7210fcb 100644
--- a/README.md
+++ b/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: ".ping", ".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
 
@@ -27,14 +27,14 @@ func main() {
 	b.AddCommands(
         // .ping can be run at any time by anyone and will respond with 'pong'
 		bolt.Command{
-			Trigger: ".ping",
+			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",
+			Trigger: "time",
 			Payload: func(msg bolt.Message) (res string, err error) {
 				return "yer", nil
 			},
@@ -42,7 +42,7 @@ func main() {
 		},
         // .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
 			},
diff --git a/bolt.go b/bolt.go
index 3fe6eff..b1c80e9 100644
--- a/bolt.go
+++ b/bolt.go
@@ -25,6 +25,7 @@ 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 {
@@ -46,18 +47,25 @@ 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
@@ -108,10 +116,11 @@ func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) {
 		return
 	}
 
-	//does the message have the command indicator "."
-	if msg.Content[:1] == "." {
+	//does the message have the command indicator
+	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
 		}
diff --git a/command.go b/command.go
index 18a02b6..d6f39d2 100644
--- a/command.go
+++ b/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
diff --git a/option.go b/option.go
new file mode 100644
index 0000000..b2c1979
--- /dev/null
+++ b/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
+	}
+}