From dcef0b65069fb38fd0f6c4382353167f603ebff1 Mon Sep 17 00:00:00 2001 From: LLLL Colonq Date: Thu, 16 Nov 2023 19:06:43 -0500 Subject: Initial commit --- deps/discord-haskell/docs/embeds.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 deps/discord-haskell/docs/embeds.md (limited to 'deps/discord-haskell/docs/embeds.md') diff --git a/deps/discord-haskell/docs/embeds.md b/deps/discord-haskell/docs/embeds.md new file mode 100644 index 0000000..eec38d9 --- /dev/null +++ b/deps/discord-haskell/docs/embeds.md @@ -0,0 +1,21 @@ + +### Embeds + +Embeds are special messages with boarders and images. [Example embed created by discord-haskell](./examples/embed-photo.jpg) + +The `Embed` record (and sub-records) store embed data received from Discord. + +The `CreateEmbed` record stores data when we want to create an embed. + +`CreateEmbed` has a `Default` instance, so you only need to specify the fields you use: + +```haskell +_ <- restCall (R.CreateMessageEmbed "Pong!" $ + def { createEmbedTitle = "Pong Embed" + , createEmbedImage = Just $ CreateEmbedImageUpload + , createEmbedThumbnail = Just $ CreateEmbedImageUrl + "https://avatars2.githubusercontent.com/u/37496339" + }) +``` + +Uploading a file each time is slow, prefer uploading images to a hosting site like imgur.com, and then referencing them. -- cgit v1.2.3