discord_embed_builder-custom

Discord Embed Builder - Custom Setup

Note (18/10/2020): This page is currently undergoing a reconstruction to make it more informative and useful. Please bare with us while this change is being made.

The Discord integration in DeepBot allows you to do some pretty cool things with regards to presenting messages to your Discord server. One such way you can present generated text is through the use of embeds.
The following guide will go over what is needed in order to make a custom embed for your command to output.

  1. Go to the following URL for the embed builder that is used to generate the code used by Deepbot - Embed Builder
  2. Optional: Copy one of the example JSON codes outlined in the example outputs section below.
  3. Edit the results on the left hand text box. This will be reflected in the preview window on the right of the webpage.
  4. When you are happy with the results, click on “Generate Code”
  5. In the resulting text simply copy/paste into your command
  6. Ensure that the command is set to run via Discord ONLY. If this is not done a lot of nonsense will be posted to your Twitch chat!

In order to tag a particular user/channel/role in the message that is posted you will need to get the ID of the appropiate object.
This is then added to the “Content” portion of the JSON code that is produced.
In order to get the ID of the user/channel/role that you need you will need to enable developer mode which can be done by the Apperance options in your Discord settings.
Once this is enabled you will be able to right click a user, channel or role and click the “Copy ID” option.

In order for Deepbot to make use of this you will need to copy the ID in the following formats

Type Structure Example
User <@USERID> OR <@!USERID> <@103735883630395392>
Channel <#CHANNELID> <#103735883630395392>
Role <@&ROLEID> <@&109402775317643264>

Notes This explains what the code within deepbots code does compared to the json above

fi= 0=FALSE 1= TRUE, field inline, to have to sections inline next to each other will move to new line if row is full.
fn= field name, the name you want to display for that sections.
fv= field text, this is the text that will display under the section name.
content=CONTENT
title=TITLE
description=DESCRIPTION
titleUrl=TITLE URL MUST BE WEBSITE LINK
color=purple, darkpurple, blue, darkblue, green, darkgreen, lightergrey, lightgrey, darkgrey, darkergrey, magenta, darkmagenta, lightorange, orange, darkorange, red, darkred, teal, darkteal, gold
timestamp=0=FALSE 1= TRUE
footerText=FOOTER TEXT footer
footerIcon=FOOTER ICON IMAGE MUST BE URL TO PICTURE
thumbnailUrl=THUMBNAIL ICON IMAGE MUST BE URL TO PICTURE
imageUrl=IMAGE THE WILL DISPLAYED IN THE EMBED MUST BE URL TO PICTURE
authorName=AUTHOR NAME
authorIcon=AUTHOR PICTURE MUST BE URL TO PICTURE
authorUrl=LINK TO GO TO WHEN AUTHOR IS CLICKED

JSON Code Output
{
  "content": "Test",
  "embed": {
    "title": "Test Title",
    "description": "Test Description",
    "url": "http://deepbot.tv",
    "color": "purple",
    "timestamp": "1",
    "footer": {
      "icon_url": "http://deepbot.tv/images/team/team_experts.c8d45f45.jpg",
      "text": "footer text"
    },
    "thumbnail": {
      "url": "http://deepbot.tv/images/team/team_experts.c8d45f45.jpg"
    },
    "image": {
      "url": "http://deepbot.tv/images/team/team_experts.c8d45f45.jpg"
    },
    "author": {
      "name": "@user@",
      "url": "https://discordapp.com",
      "icon_url": "http://deepbot.tv/images/team/team_experts.c8d45f45.jpg"
    },
    "fields": [
      {
        "name": "field one",
        "value": "test 1",
        "inline": true
        
      },
      {
        "name": "field two",
        "value": "test 2",
        "inline": true
      }
    ]
  }
}
 
  • discord_embed_builder-custom.txt
  • Last modified: 2020/10/18 12:17
  • by dante557