README
¶
Sunbot
Stateless Discord bot originally made for the Cuddle Puddle discord server.
Art by HiccupsDoesArt
Setup
Sunbot is intended to be used with one instance per Discord server/guild. You CAN connect it to separate servers, however the databases will be merged (if you choose to use one).
Sunbot is entirely stateless, however it depends on several environment variables to be set.
The .env.sample file should contain up-to-date listing in case this readme is neglected (it's possible).
* - required
-
DISCORD_AUTH_TOKEN* - Discord bot API token -
COMMAND_PREFIX- Prefix used by users to execute commands (default.) -
DEBUG_OUTPUT- Verbose debug output (defaulttrue) -
SILLY_COMMANDS- Enable the silly commands which do not use the command prefix (defaulttrue) -
DERPIBOORU_API_KEY- API key for Derpibooru queries (leave blank if none)
Dockerfile and launch script are included here as well as techniponi/sunbot on Docker Hub, which will always pull the latest commit on launch. A "stable" release will exist eventually.
Note: the Redis database functionality has been disabled until further notice. Focus will be directed at the stateless functionality for now.
Commands
Use .help and .help [verb] for an up-to-date list. All commands and help info are defined in commands.go.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
_vendor-20180104213450
|
|
|
github.com/bwmarrin/discordgo
Package discordgo provides Discord binding for Go
|
Package discordgo provides Discord binding for Go |
|
github.com/go-redis/redis
Package redis implements a Redis client.
|
Package redis implements a Redis client. |
|
github.com/go-redis/redis/internal/consistenthash
Package consistenthash provides an implementation of a ring hash.
|
Package consistenthash provides an implementation of a ring hash. |
|
github.com/gorilla/websocket
Package websocket implements the WebSocket protocol defined in RFC 6455.
|
Package websocket implements the WebSocket protocol defined in RFC 6455. |
|
golang.org/x/crypto/nacl/secretbox
Package secretbox encrypts and authenticates small messages.
|
Package secretbox encrypts and authenticates small messages. |
|
golang.org/x/crypto/poly1305
Package poly1305 implements Poly1305 one-time message authentication code as specified in https://cr.yp.to/mac/poly1305-20050329.pdf.
|
Package poly1305 implements Poly1305 one-time message authentication code as specified in https://cr.yp.to/mac/poly1305-20050329.pdf. |
|
golang.org/x/crypto/salsa20/salsa
Package salsa provides low-level access to functions in the Salsa family.
|
Package salsa provides low-level access to functions in the Salsa family. |