Dink

Dink sends webhook messages upon noteworthy in-game events. While Dink supports the Discord webhook format (with rich embeds and optional screenshots), it also includes additional metadata that allows custom webhook servers to analyze messages or even generate their own messages. Examples of the additional metadata can be found here. This project was forked from UniversalDiscordNotifier, but has more features, reliability, configurability, testing, and maintainer activity. You can compare Dink to other Discord webhook plugins here.

Have a suggestion (e.g., new notifier, additional data), bug report (as rare as it may be), or question? Let us know on our issue tracker!

Basic Setup

To use this plugin, a webhook URL is required; you can obtain one from Discord with the following steps:
_{If you already have a link, skip to step 4.}

1. Click the server name (at the top-left of your screen) and select Server Settings.
2. Select the Integrations tab on the left side and click Create Webhook (if other webhooks already exist, click View Webhooks and New Webhook).
3. Click the newly created webhook, select the target Discord channel, and click Copy Webhook URL.
4. Paste the copied link into the Primary Webhook URLs box in the Dink plugin settings.
5. (Optional): If you would like different webhook URLs to receive different sets of notifications, you can instead paste the link into each relevant box in the Webhook Overrides section. Note: when a notifier has an override URL, the notifier ignores the primary URL box.

Notifiers

• Death: Send a webhook message upon dying (with special configuration for PK deaths)
• Collection: Send a webhook message upon adding an item to your collection log
• Level: Send a webhook message upon leveling up a skill (with support for virtual levels and XP milestones)
• Loot: Send a webhook message upon receiving valuable loot (with item rarity for monster drops)
• Slayer: Send a webhook message upon completing a slayer task (with a customizable point threshold)
• Quests: Send a webhook message upon completing a quest
• Clue Scrolls: Send a webhook message upon solving a clue scroll (with customizable tier/value thresholds)
• Kill Count: Send a webhook message upon defeating a boss (with special configuration for personal best times)
• Combat Achievements: Send a webhook message upon completing a combat task (with customizable tier threshold)
• Achievement Diaries: Send a webhook message upon completing an achievement diary (with customizable difficulty threshold)
• Pet: Send a webhook message upon receiving a pet
• Speedrunning: Send a webhook message upon completing a quest speedrun (with special configuration for personal best times)
• BA Gambles: Sends a webhook message upon receiving high level gambles from Barbarian Assault
• Player Kills: Sends a webhook message upon killing another player (while hitsplats are still visible)
• Group Storage: Sends a webhook message upon Group Ironman Shared Bank transactions (i.e., depositing or withdrawing items)
• Grand Exchange: Sends a webhook message upon buying or selling items on the GE (with customizable value threshold)
• Trades: Sends a webhook message upon completing a trade with another player (with customizable item value threshold)
• Leagues: Sends a webhook message upon completing a Leagues IV task or unlocking a region/relic
• Chat: Sends a webhook message upon receiving a chat message that matches a user-specified pattern
• External Plugins: Sends a webhook message upon request by other plugin hub plugins

Other Setup

Some notifiers require in-game settings to be configured to send chat messages upon certain events (so these events can serve as triggers for webhook notifications).

• Collection notifier requires Settings > All Settings > Chat > Collection log - New addition notification (or New addition popup) to be enabled
• Pet notifier recommends Settings > All Settings > Chat > Untradeable loot notifications to be enabled (which requires Settings > All Settings > Chat > Loot drop notifications) in order to determine the name of the pet
• For Kill Count notifier, ensure you do not enable Settings > All Settings > Chat > Filter out boss kill-count with spam-filter (note: this setting is already disabled by default by Jagex)

Example

Advanced Features

• Multiple webhook urls are supported; simply place each on a separate line
• Each notifier can send webhook messages to separate "override" urls
• Screenshots can be individually configured for each notifier
• Screenshots are compressed if needed to comply with Discord limits
• The chat box (and private messages above chat) can be hidden from screenshots
• The plugin can skip notifications for player names that do not comply with the user-configured RSN filter list
• Users can choose whether their webhook messages are sent in Discord's rich embed format or a traditional format
• The player name in Discord rich embeds can be linked to various tracking services (from HiScores to Wise Old Man)
• Discord rich embed footers can be customized with user-specified text and image url
• When network issues occur, Dink can make repeated attempts to send the webhook (with exponential backoff)
• Notifications can be sent to Discord Forum Channels; append ?forum to the end of the webhook url to create a new thread per message or use ?thread_id=123456 to post to an existing forum thread (be sure to change 123456 with the actual thread ID). For forum channels, you can also include &applied_tags=123,456 to specify certain tags for the new thread (be sure to change 123, 456 with the tag IDs you wish to apply). To achieve different tags for different notification types, you should utilize the Webhook Overrides section (and can share these settings via config export)
• Character metadata can be sent to custom webhook handlers on login for tracking relevant statistics.

Chat Commands

Export Current Configuration via ::dinkexport

Dink allows you to export your current plugin configuration to the clipboard via the ::dinkexport chat command.

You can share this produced JSON to friends who want to send similarly configured messages.

This export includes settings across all of the notifiers, but omits webhook URLs. If you also want to include webhook URLs in the export, you can use the all parameter to the command: ::dinkexport all.

If you only want to export the webhook URLs, run the ::dinkexport webhooks chat command.

You can export just the settings for select notifiers.
Simply run: ::dinkexport <notifier section header name without spaces>.
For example: ::dinkexport pet or ::dinkexport collectionlog.

Examples

• Export notifier settings, primary webhook URLs & webhook override URLs
  ::dinkexport all
• Export Slayer & BA Gambles Notifier settings
  ::dinkexport slayer bagambles
• Export webhook overrides only
  ::dinkexport webhookoverrides
• Export all webhooks & the Levels notifier settings:
  ::dinkexport webhooks levels

Import Configuration via ::dinkimport

With the output of the above command (::dinkexport) copied to your clipboard, you can merge these settings with your own via the ::dinkimport chat command.

This import can replace all of your notifier settings. However, webhook URL lists, filtered RSNs, and filtered item names for the loot notifier would be combined, rather than outright replaced. If you would like all settings overwritten rather than merged during import, simply press the Reset button at the bottom of the plugin settings panel to clear out all settings (including URLs) before running ::dinkimport.

After an import, if the dink plugin settings panel was open, simply close and open it for the updated configuration to be reflected in the user interface.

Note: There is no undo button for this command, so consider making a backup of your current Dink configuration by using the ::dinkexport all command explained above and saving that to a file on your computer.

Warning: If you import override URLs for a notifier (that previously did not have any overrides), this will result in the plugin no longer sending messages from that notifier to your old primary URLs. As such, you can manually add your primary URLs to the newly populated override URL boxes so that notifications are still sent to the old primary URLs.

Migrate configuration from other webhook plugins via ::DinkMigrate

When switching to Dink from other Discord webhook plugins, you can utilize the ::DinkMigrate command to automatically import your configuration from the other plugins into Dink on a best-effort basis. Like ::DinkImport, most settings are replaced outright while others are merged (e.g., webhook URLs, filtered RSNs, and filtered item names).

This migration can be imperfect so we recommend verifying the updated Dink configuration post-migration. Also, if you already have used Dink, we recommend saving the output of ::DinkExport all before migrating just in case you want to revert any changes.

When executing the ::DinkMigrate command, you must specify which plugin to import or all to migrate all supported plugins. In particular, Dink supports migrating the following plugins: BetterDiscordLootLogger, DiscordCollectionLogger, DiscordDeathNotifications, DiscordLevelNotifications, DiscordLootLogger,