# README
Unison
Unison is a framework for Discord chat bots written in Go.
It is currently used to power the stackguru bot for the /r/Nootropics Discord server.
Written and maintained by @s1kx and @sciencefyll.
Features
- Configurable bot modes
- Custom commands
- Custom event hooks
- Access control
Project status
The different labels of this repository.
Requirements
Development
Collaborators and pull requests are very welcome.
We use the following guidelines:
- Semantic Versioning
- Git flow as outlined in this article
# Packages
Package events implements event mapping for the discordgo library.
# Functions
No description provided by the author
NewContext Create a new context class for the discord bot This will also hold a signal for system interupts.
No description provided by the author
# Constants
No description provided by the author
# Structs
Bot is an active bot session.
BotSettings contains the definition of bot behavior.
Command is the interface that every bot command must implement.
Designed to handle X guilds per bot instance.
Context is a type that is passed to every handler in a bot application.
Duplicate command error.
Duplicate command prefix error.
Duplicate event hook error.
Duplicate event hook error.
Hook interface for anything that is supposed to react on a event, besides commands.
No description provided by the author
Too short command prefix error.
# Type aliases
CommandActionFunc is the action to execute when a command is called.
EventHandlerFunc handles a discord event and returns whether it handles the event type and if an error occured.
CommandActionFunc is the action to execute when a command is called.