SQF Discord Embed Builder

A discord webhook addon using basic SQF/Arma configs so even beginners can easily send webhook messages directly from an Arma 3 Server.

Features

• 2-step installation
• Design embeds how you want in Arma config format
• Use SQF parameters for dynamic text content

Note

• You may need to install .NET Framework 4.5.2.
• The extensions were built and tested on Arma 3 Dedicated Server.
• This addon does work on Arma client however the extensions are NOT BattlEye whitelisted.

Setup

The following instructions are for an Arma 3 Server using the latest release.

1. Place @DiscordEmbedBuilder in your server root folder
2. Add the mod to your command line -serverMod=@DiscordEmbedBuilder

Make your own embeds

Config Templates

The config is where you design message templates. The idea with templates is you can write up the structure of your message in the config, and use that structure in multiple scripts. There are quite a few settings for the each message which are explained below.

Basic settings

Example.cpp

• webhook - CfgDiscordEmbedWebhooks identifier.
• message - The text content of your message. This example uses This is an example message.
  
• username - The name of the bot when it sends the message. If this is not set Discord will use the name set in the webhook settings.
• avatar - The avatar of the bot when it sends the message. If this is not set Discord will use the image set in the webhook settings.
• tts - Text to speech.

That's all you need to send a simple text message, however there are more settings to configure embeds.

Embed settings

Messages can contain up to 10 embeds. These embeds must be defined inside the Embeds subclass. CfgDiscordEmbedTemplate
Example2.cpp

• title - Embed title text.
• description - Description text, located under the title.
• url - Link opened when you click the title text.
• color - RGB color code. eg: Red FF0000.
• timestamp - Show timestamp in the embed footer.
• thumbnail - Image shown in the top right corner of the embed.
• image - Full embed width image shown at the bottom of the embed under all fields.
• fields - Array of embed fields. Maximum of 25 fields per embed.

Author (Subclass)

• name - Author name, located above the title text.
• url - Link opened when you click the author name.
• image - Tiny image shown to the left of the author name.

Footer (Subclass)

• text - Footer text, shown to the left of the timestamp (if enabled).
• image - Small image shown to the left of the footer text.

SQF

Using a config template

When using config templates, the only sqf you need to use is this:

[type,parameters] call DiscordEmbedBuilder_fnc_buildCfg;

1. Type: STRING - The name of the config class in CfgDiscordEmbedBuilder you wish to use.
2. Parameters: ARRAY (optional) - Any value you want to use in the embed.

Parameters are used in message, username, embed title, embed description, author name, footer text, field name and field content with the format command:

format([string]+parameters);

Build with SQF

You can build entire messages in SQF if you prefer that to configs. I suggest only using it for simple messages, however the system has full support for all the same settings as config templates so you can do what you like.

SQF Examples

[
    "webhook identifier", // CfgDiscordEmbedWebhooks
    "message",
    "title",
    "avatar url",
    false, // tts
    [ // Maximum 10 embeds per message
        [
            "embed title",
            "embed description",
            "url",
            "00FF00", // color RBG
            true,     // use timestamp
            "thumbnail url",
            "image url",
            [
                "author name",
                "author url",
                "author image"
            ],
            [
                "footer text",
                "footer image"
            ],
            [ // Maximum 25 fields per embed
                [
                    "field title",
                    "field content",
                    true  // inline
                ],
                [ /* another field */ ],
                [ /* another field */ ],
                [ /* another field */ ],
                [ /* another field */ ]
            ]
        ],
        [ /* another embed */ ],
        [ /* another embed */ ]
    ]
] call DiscordEmbedBuilder_fnc_buildSqf;

Connecting your message to the webhook

1. Open your Discord client and open the settings of the channel you want your message to send to.
   
2. Click Webhooks on the left panel, then click Create Webhook.
   
3. Scroll down to Webhook URL, click Copy.
   
4. Create a unique property inside CfgDiscordEmbedWebhooks and remove the base URL.

class CfgDiscordEmbedWebhooks {
    // https://discordapp.com/api/webhooks/000000000000000000/XXXXXXX_XXXXXXXXXXXXXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
    Example="000000000000000000/XXXXXXX_XXXXXXXXXXXXXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
};

5. Set webhook in your config template to the new property name, or use the new property name in the first element of your SQF build array.

Video tutorial

Here is a video tutorial showing how to set up your webhook. There is no audio to it but it shows you exactly what to do.
https://www.youtube.com/watch?v=yF0UEiUnL9E