tablebot

An extendable Discord bot framework written on top of discord-haskell.

If you're new to this project, or completely new to git, and Haskell, you might be interested in looking at the Setup from Scratch guide. If you want to contribute, please consult the contributor's guide. If you want tutorials on making your first plugin or how exceptions work, checkout the tutorials in the tutorials folder.

Environment file setup

Create a .env file containing the following keys. Consult .env.example if you're unsure how this should be formatted! Please note that the .env file must have a newline at the end of it - i.e. the last line should be blank.

• DEBUG (mandatory) - whether the bot should run in debug mode. This bypasses all permission checks, and prints certain log message that would otherwise be suppressed
• DISCORD_TOKEN (mandatory) - the Discord token for your bot. Go to the Discord Developer Portal, create an application representing your bot, then create a bot user and copy its token.
• PREFIX (optional, defaults to !) - the prefix for each bot command. For example, if you set it to $, then you would call $ping to ping the bot.
• SQLITE_FILENAME (mandatory) - a name for your SQLite database, for example database.db.
• CATAPI_TOKEN (optional) - the api token to get cat pictures. Go to The Cat API to create an account and get a token so you can enjoy cats.
• EXEC_GROUP (optional) - the group ID assigned to exec members.
• MODERATOR_GROUP (optional) - the group ID assigned to moderator members.
• SUPERUSER_GROUP (optional) - the group ID assigned to the superuser. Strongly recommended
• SERVER_ID (optional) - either global or the id of the server the bot will mainly be deployed in. Application commands will be registered here. If absent, application commands won't be registered.
• EMOJI_SERVERS (optional) - a list of server IDs that the bot will search for emoji within.
• ALLOW_GIT_UPDATE (optional) - a true or false value that determines whether the bot can automatically load data from the repository. Warning! Be very careful with setting this to true; if you haven't set up permissions properly on your repo and your discord servers then things can go wrong!

The three Group settings are optional, but without them any commands that require elevated permissions will not be able to be called when DEBUG is false. Users with the superuser group are able to run every command (including some dangerous ones), so caution should be used when setting these up.

If you have any difficulties setting it up, see the setup guide for a walkthrough.

Importing this bot and running it yourself.

If you like, rather than directly running this bot you can run it yourself with minor tweaks. An example of this is in app/Main.hs - tweak this to your needs and then run stack run as per usual.