discord_embed_builder-custom

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
discord_embed_builder-custom [2017/11/25 22:07]
ianchandler1990
discord_embed_builder-custom [2020/10/18 12:17] (current)
dante557 [Tagging User/Channel/Role] Added additional structure option for a specific user to be tagged in a message
Line 1: Line 1:
-~~NOTOC~~ 
 ====== Discord Embed Builder - Custom Setup ====== ====== Discord Embed Builder - Custom Setup ======
  
-  * **[[discord_embed_builder-custom#Overview|Overview]]** +<color #ed1c24>**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.**</color>
-  * **[[discord_embed_builder-custom#Setup|Setup]]** +
-  * **[[discord_embed_builder-custom#Samples|Samples]]** +
-  * **[[discord_embed_builder-custom#Explanation|Explanation]]**+
  
-----+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. 
  
-===== Overview =====+===== Setup =====
  
-This guide will go over a few different things you should know about making a custom embed for discord.+  - Go to the following URL for the embed builder that is used to generate the code used by Deepbot - [[http://deepbot.tv/utils/embed-builder/|Embed Builder]]  
 +  - Optional: Copy one of the example JSON codes outlined in the example outputs section below. 
 +  - Edit the results on the left hand text box. This will be reflected in the preview window on the right of the webpage. 
 +  - When you are happy with the results, click on "Generate Code" 
 +  - In the resulting text simply copy/paste into your command 
 +  - Ensure that the command is set to run via Discord ONLYIf this is not done a lot of nonsense will be posted to your Twitch chat!
  
-**Note** Please keep in mind that this guide is for advance users that know some kind of json formating.+===== Tagging User/Channel/Role ====
  
-----+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.
  
-===== Setup =====+In order for Deepbot to make use of this you will need to copy the ID in the following formats
  
-1. Copy the example code from below paste it into the json that is on the [[http://deepbot.tv/utils/embed-builder/|Embed Builder]]+^ Type ^ Structure ^ Example ^ 
 +|User | <@USERID> OR <@!USERID> | <@103735883630395392>
 +|Channel| <#CHANNELID> | <#103735883630395392>
 +|Role| <@&ROLEID> | <@&109402775317643264> |
  
-2. On the bottom of the Embed Builder there will be a button to generate the correct code to place into a custom command.+===== Explanation =====
  
-**Note:** make sure that when making a command that has embeds that you set the command to only run via discord under the Activation settings for the command! +**Notes** This explains what the code within deepbots code does compared to the json above
- +
-**Important** How to get tagged @username @role and #room into an embed! +
- +
- +
-^ Type ^ Structure ^ Example ^ +
-|User | \@User | <@80351110224678912>+
-|Channel| \#Channel| <#103735883630395392>+
-|Role| \@Role | <@&165511591545143296> |+
  
 +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\\
  
-----+===== Example Outputs  =====
  
-===== Samples ===== +^ JSON Code ^ Output ^ 
- <code>+<code>
 { {
   "content": "Test",   "content": "Test",
Line 76: Line 92:
   }   }
 } }
- </code> + </code> | {{::deepbot_embed_output_1.png?nolink&600|}} |
- +
----- +
- +
-===== Explanation ===== +
- +
-**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\\+
  
  • discord_embed_builder-custom.1511647625.txt.gz
  • Last modified: 2017/11/25 22:07
  • by ianchandler1990