Discord Webhook - No-Not-Jaden/NotBounties GitHub Wiki

Webhook Picture

Messages can be sent from NotBounties to Discord without any external plugin. All configuration is located in the webhooks.yml file

Setup

  • Create your webhook link in Discord. Server Settings > Webhooks > Create Webhook
  • Copy the webhook link and paste it into the top line of the webhooks.yml file.
  • Reload the plugin

Discord webhooks will be sent whenever a bounty is set, claimed, edited, or removed.

Customization

The rest of the webhooks.yml file is for customizing the webhooks. Apart from the text-to-speech option, which speaks out the messages, each message can be customized individually. For the options with text, markdown format and placeholders can be used.

Enabling/Disabling

Each message has its own enabled option. You can choose which of these you want to be sent. To disable all of the messages at once, you can change the webhook link or set it to https://discord.com/api/webhooks/....

Username

The username option controls the username of the webhook when the message is sent. Using {player} will set it to the Minecraft name of the player who triggered the event, and {receiever} will set it to the name of the receiver of the event. Use blank quotes: username: '' if you want to use the webhook's name instead.

Message

The message option controls the regular text that is sent. This is the normal Discord message.

Switch Images

The switch-images option switches the avatar image and the image displayed in the message. By default, the avatar image is the player, and the message image is the receiver.

Send Image

The send-image option controls whether an image should be sent of the player head in the embed.

Embed

The rest of the options are for the embed in the message. This is the box with text that bots usually send and normal players can't.

Title

The title option is the heading text of the embed. This text is usually slightly thicker than the normal text.

Description

The description option is the text under the title of the embed.

Color

The color option is the color around the embed. The color can be the name of a color from here, or hex #4287f5, or RGB 216, 59, 227.

Footer

The footer is the text at the bottom of the embed that is slightly smaller than the normal text.

Text

The text option is the text of the footer.

Image URL

The image-url option is a place for an optional image URL you want in the footer

Content

The content of the embed is like the description, but you can have multiple different fields in the content and make the fields in line with each other. The format is:

content:
  field:
    name: 'Title'
    value: 'Description'
    inline: true
  # can be named whatever
  field2:
    ...

The name is the title of the field and is displayed on top. The value is the description of the field and is displayed under the title. The inline option will determine if the text will be on the same line of text from other fields. This is only if there is enough space on the line.

Related Pages