[chore] cleaning

- removing old or commented code
- removing unused or deprecated types
- commenting everything, probably too much
- split msgEventHandler logic into methods
- readme update, removed most docs the pkg site looks good
- adjusted intents option, no need for a type

message.go

@@ -8,14 +8,14 @@ import (
 )
 
 const (
-	// the max length allowed for basic messages
+	// the max length allowed for basic messages, if the message content exceeds this amount
+	// then messages are split unto chunks of max size
 	MSG_MAX_LENGTH = 2000
 )
 
-// command payload functions, any strings returned are sent as a response to the command
+// command and message payload function type
 type Payload func(c *Context) error
 
-// message attachment details
 type MessageAttachment struct {
 	ID           string
 	URL          string
@@ -28,31 +28,41 @@ type MessageAttachment struct {
 	DurationSecs float64
 }
 
+// Author contains basic information about message authors
 type Author struct {
 	Name  string
 	ID    string
 	Roles []string
 }
 
+// Message contains all needed data to handle message events
 type Message struct {
-	Author      Author
-	ID          string              //message ID
-	Words       []string            //message data split on whitespaces
-	Content     string              //entire message data string
-	Channel     string              //name of channel message was sent in
-	ChannelID   string              //ID of channel message was sent in
-	Server      string              //name of guild message was sent in
-	ServerID    string              //ID of guild message was sent in
+	Author Author
+	//current message ID
+	ID string
+	//message content split on whitespace to allow for easy argument parsing with commands
+	Words []string
+	//entire message content unchanged
+	Content string
+	//channel message was sent in, name and ID
+	Channel   string
+	ChannelID string
+	//guild message was sent in, name and ID
+	Server   string
+	ServerID string
+	//message extras
 	Attachments []MessageAttachment //any attachments bound to the message
-	Mentions    []*dg.User
+	Mentions    []*dg.User          //users mention in the message with @
 }
 
+// Context is the struct passed to message and command handlers, it contains all needed message data as well as
+// some methods to make interaction with the message as easy as possible
 type Context struct {
 	Message *Message
 	bolt    *bolt
 }
 
-// React applies reaction to the message
+// React applies the reaction to the message
 func (c *Context) React(emoji Reaction) error {
 	return c.bolt.MessageReactionAdd(c.Message.ChannelID, c.Message.ID, fmt.Sprint(emoji))
 }
@@ -85,7 +95,7 @@ func (c *Context) Respond(res string) error {
 		return nil
 	}
 
-	//short enough message to send in one go
+	//short enough message to send in one go, so ship it
 	rep := c.bolt.createReply(res, c.Message.ID, c.Message.ChannelID, c.Message.ServerID)
 	_, err := c.bolt.ChannelMessageSendComplex(c.Message.ChannelID, rep)
 	return err
@@ -96,18 +106,23 @@ func (c *Context) Delete() error {
 	return c.bolt.ChannelMessageDelete(c.Message.ChannelID, c.Message.ID, nil)
 }
 
+// Timeout creates a user timeout for the supplied userID that lasts until duration is exceeded or the
+// timeout is cleared
 func (c *Context) Timeout(userId string, duration time.Time) error {
 	return c.bolt.GuildMemberTimeout(c.Message.ServerID, userId, &duration)
 }
 
+// ClearTimeout clears existing user timeouts, allowing them access again
 func (c *Context) ClearTimeout(userId string) error {
 	return c.bolt.GuildMemberTimeout(c.Message.ServerID, userId, nil)
 }
 
+// Mute handles muting a user from Voice Chat, this mute stays until it is Unmute()'d
 func (c *Context) Mute(userId string) error {
 	return c.bolt.GuildMemberMute(c.Message.ServerID, userId, true)
 }
 
+// Unmute removes a mute on the user, allowing them vc access again
 func (c *Context) Unmute(userId string) error {
 	return c.bolt.GuildMemberMute(c.Message.ServerID, userId, false)
 }