[chore] comments and function scope
- methods no longer exported if not used - readme update - comments updated
This commit is contained in:
28
README.md
28
README.md
@@ -1,12 +1,30 @@
|
||||
# bolt
|
||||
|
||||
Base Discord bot framework
|
||||
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.
|
||||
|
||||
## 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 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.
|
||||
## Usage
|
||||
### Token
|
||||
Bolt requires a Discord bot token to run, the token must be set as an environment variable labeled "DISCORD_TOKEN"
|
||||
|
||||
## Basic Usage
|
||||
bolt allows developers to create a Discord bot with a discord bot token and a few lines of Go code, discord tokens must be set as an environment variable labeled DISCORD_TOKEN. 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.
|
||||
### 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.
|
||||
```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
|
||||
}
|
||||
```
|
||||
|
||||
### 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.
|
||||
```go
|
||||
type Payload func(msg Message) (string, error)
|
||||
```
|
||||
|
||||
### Example
|
||||
```go
|
||||
package main
|
||||
|
||||
|
Reference in New Issue
Block a user