diff --git a/docs/guide/embeds.md b/docs/guide/embeds.md index b663d0bfc..076363e14 100644 --- a/docs/guide/embeds.md +++ b/docs/guide/embeds.md @@ -1,23 +1,23 @@ # Embeds -Embeds are generated by a few commands as a URL that can be loaded in a browser/streaming software. +Embeds are URLs generated by commands or tools that represent the "naked" version of the respective command or tool ## Creating Embeds -1. Use a command of your liking (for example, `/stats`). -2. Customize the command however you like and the URL generated for the embed will match your needs. -3. Send the command and when the bot is "done thinking," an "Embed" button will appear below the bot's reply. +1. Use a command or tool and click on "Embed" if it's available +2. Make sure to tweak the settings of the command or tool because embeds replicate everything ## Using Embeds in Streaming Softwares -1. Click on the "Embed" button. -2. Copy the URL from your browser. -3. Paste the URL into a Browser Source. -4. Set the refresh rate/FPS to something very low like `0.0167` (that's 1 frame every 60 seconds). +1. Click on the "Embed" button + - If this was generated by a command, copy the URL from the browser + - If this was generated by a tool, the URL has been copied to your clipboard already +2. Paste this URL into your streaming service as a "Browser Source" + - Tool embeds use local storage so data won't be transferred from you browser to your streaming software + - Make sure to visit the tool's page in your streaming software (using the "Interact" feature) and then open the embed + - Set your browser source refresh rate to `1Hz` because that's how fast embeds refresh ## How Embeds Behave -- They load like any normal website albeit with a significant delay. -- They auto refresh every `60s`. -- All embeds and images generated by Blitzkrieg have a width of `640px` but the height varies and must be found manually through trial and error. - - It's okay to have a Browser Source that has a height larger than needed as Blitzkrieg embeds are transparent. +- They load like any normal website +- They auto refresh every `1s`