A pluggable bot for your Discord server, written in Golang.

Digo is in very active development. At this point, things shouldn't
drastically change, but they may.

• (Mostly) stable bot, with automatic rejoin / reconnect!
• Runs any number of plugins, written in any language
• Exposes a simple API for long-running services and daemons.
• Cross platform (Linux, Mac, in theory, Windows?)

Currently, Digo is configured through environment variables. Might support configuration files (TOML?) in the future.
Your server ID (also known as Guild ID) can be found here
Here is an example wrapper script.

#!/bin/sh
export [email protected]
export DIGO_DISCORD_PASS=*****
export DIGO_SERVER_ID=123456789
export DIGO_DISABLE_API=false
export DIGO_API_INTERFACE=127.0.0.1:8086
export DIGO_API_USERNAME=mydigo
export DIGO_API_PASSWORD=secretpass
export DIGO_DISCORD_INVITE_ID=xuja8ije23
export DIGO_TRIGGER=/bot
export DIGO_LOG_LEVEL=info  # set to debug at your own peril
export DIGO_LOG_FILE=/var/log/digo.log
export DIGO_LOG_STREAMS=stdout,file
./digo

Digo only needs the following permissions from Discord:

• Read Messages
• Send Messages
• Manage Messages (if DIGO_LEAVE_TRIGGERS is false, to delete trigger messages)

This assumes you have not changed your DIGO_TRIGGER from /bot

/bot reload # registers and unregisters plugins added / removed from the plugin directory
/bot plugins # lists all plugins installed and their triggers

Plugins can be written in any language. If the shell can execute the program, Digo will be able to use execute it as well.

Digo scans the following paths (in order) to determine the plugin directory. If anyone cares, this could be made configurable.

• /opt/digo/plugins
• /usr/local/digo/plugins
• ./plugins # local to the binary

Simply create one of those directories, place your plugin executables there, and Digo will do the rest!

When Digo first starts, it iterates over most files in the plugins directory. If the file begins with "_" or "." it is skipped. These prefixes are useful if your plugin requires an external configuration file.

Once it has the list of plugins, it runs the plugin with the argument "register". It expects the plugin to output JSON to stdout in the following format.

{
   "triggers" : [
      "/youtube",
      "/yt"
   ],
   "description" : "Searches youtube for keywords",
   "type": "simple",
   "name" : "youtuber"
}

Once the plugin is registered, Digo will run the plugin whenever a trigger is mentioned in chat. Digo will pass every word after the trigger as an argument to the plugin.

/yt cool cat videos

The youtuber plugis arguments will be ["plugins/youtuber.py", "cool", "cat", "videos"]

A simple plugins' stdout ends up in chat channel the trigger was called from after it exits.
Simple plugin stderr ends up in Digo's stdout (sorry).

If the trigger is mentioned with no arguments, Digo simply runs the plugin with no arguments Example, in #general, Billy writes

/yt

The youtuber plugin could respond with

Usage: /yt search keywords

If a plugin registers its type as "json", Digo will treat the plugin differently in some regards. It still expects the plugin to dump its config when passed the argument "register", but this is where the similarity to simple-type plugins ends.

When digo detects a trigger for a JSON plugin, it runs the plugin with the first argument as "json" and the second argument as stringified json.

For instance, Billy writes /roll 6d12 3d6

The diceroller plugin will receive arguments ["./diceroller.py", "json", '{"user": "Billy", "channel": "012938521123", "arguments": ["6d12", "3d6"]}']

Here is a table for the request JSON

The plugin should respond with a JSON blob to stdout in the same format the API route /v1/message takes

• Youtube KeyWord Search
• Imgur Keyword Search
• Urban Dictionary Search
• Random Insult Generator - Original Source

• Dice Roller

• Twitter Stalker
• Steam News

The API exposes a few routes. Basic Authentication can be enabled by exporting DIGO_API_USERNAME and DIGO_API_PASSWORD.

This route expects JSON in the POST data. Required fields are bold.

Example

{
  "prefix": "Example",
  "channels": ["123456789", "987654321"],
  "payload": ["This message will go to 2 channels!",
              "SO EZ!"]
}

$ go get
$ go build

• Restart / resume disconnected sessions without restarting Digo
• Hot registering / reloading when new plugins are added (without restart)
• Logging
• Godeps
• Upgrade bwmarrin/discordgo Develop branch
• Support Windows plugins by invoking interpreter directly (os/exec)
• Allow triggering plugins from content of messages (regexp, instead of just /commands)
• Configurable plugin paths
• Poll "DataReady" and "Ready" structs so we can reconnect on socket close (instead of panic)
• git submodule examples/