/clair

A Discord Bot thingy

Primary LanguageGo

Clair - Yet Another Discord Bot Project

Discord Bot written in GoLang. Reads from SQS and sends data to given Discord Channel.

Bot Configuration

.env Values

Key Optional Value Description
DISCORD_BOT_AUTH_KEY
IDENTIFIER yes
AWS_SQS_QUEUE_NAME
AWS_SQS_REGION
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY

SQS Message Structure

Message Body

v0

{
    "Content": <string>,    // message content
    "Embed": {
        "Title": <string>,       // embed title
        "Description": <string>, // embed description
        "Image": <string>,       // image url
        "Color": <string>,       // Hex color of the embed without `#`
    }
}

v1

v1 accepts input with the same structure as discordgo.MessageSend

{
  "Content": "some stuff with embed stuff",
  "Embeds": [
    {
      "Title": "embed title",
      "Description": "Hey go here [link](url)",
      "Image": {
        "URL": "some link to image"
      },
      "Color": "#002200"
    }
  ]
}

Message Attributes

  • VERSION : string
    The version that the message body is layed out with. Default is 0

Road Map

So that I won't get lost.

  • Register Flow
  • Login Flow
  • Passwords????
  • Basic user home page
  • Discord OAuth
  • Clair Admin /slash commands
  • Clair Webhooks
    • GET Webhook for a Discord Channel
      • YouTube-like ID system to map webhook to discord channel???
    • Webhook to Discord
    • Webhook preview for Discord