mirror of
https://github.com/blitzkit/blitzkit.git
synced 2026-10-23 19:49:50 +02:00
feat: updated embed docs
This commit is contained in:
1 parent
7f431b07e1
commit
691d5cde27
1 file changed
+12
-12
+12
-12
@@ -1,23 +1,23 @@
|
|||||||
# Embeds
|
# 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
|
## Creating Embeds
|
||||||
|
|
||||||
1. Use a command of your liking (for example, `/stats`).
|
1. Use a command or tool and click on "Embed" if it's available
|
||||||
2. Customize the command however you like and the URL generated for the embed will match your needs.
|
2. Make sure to tweak the settings of the command or tool because embeds replicate everything
|
||||||
3. Send the command and when the bot is "done thinking," an "Embed" button will appear below the bot's reply.
|
|
||||||
|
|
||||||
## Using Embeds in Streaming Softwares
|
## Using Embeds in Streaming Softwares
|
||||||
|
|
||||||
1. Click on the "Embed" button.
|
1. Click on the "Embed" button
|
||||||
2. Copy the URL from your browser.
|
- If this was generated by a command, copy the URL from the browser
|
||||||
3. Paste the URL into a Browser Source.
|
- If this was generated by a tool, the URL has been copied to your clipboard already
|
||||||
4. Set the refresh rate/FPS to something very low like `0.0167` (that's 1 frame every 60 seconds).
|
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
|
## How Embeds Behave
|
||||||
|
|
||||||
- They load like any normal website albeit with a significant delay.
|
- They load like any normal website
|
||||||
- They auto refresh every `60s`.
|
- They auto refresh every `1s`
|
||||||
- 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.
|
|
||||||
Reference in new issue
Block a user