Shop Notification Manifest
Format shop transactions announced on Discord
How a shop transaction reads once it reaches Discord. The destination is deliberately absent: it belongs to the shop, which names it on its own definition. This entry only says how the message looks, so one presentation can serve every shop and each shop still posts to its own channel. Without this entry nothing is sent, whatever the shops declare.
Fields
| Field | Type | Default | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
shopIds | List<String> | empty | Shop ids this format applies to. Empty = every shop that names a destination. | ||||||||||||
announceBuys | Boolean | true | Announce purchases | ||||||||||||
announceSells | Boolean | true | Announce sales | ||||||||||||
minimumPrice | Double | 0.0 | Announce nothing below this amount of money, so bulk trading does not flood the channel | ||||||||||||
titleTemplate | String | {player} {action} {amount}x {item} | Title of the embed. Placeholders: {player},{shop},{item},{amount},{price},{action}PlaceholdersMulti-line | ||||||||||||
contentTemplate | String | — | Optional message content sent alongside the embed. Same placeholders as the title.PlaceholdersMulti-line | ||||||||||||
buyVerb | String | bought | Wording substituted for {action} on a purchase | ||||||||||||
sellVerb | String | sold | Wording substituted for {action} on a sale | ||||||||||||
color | String | #55ff55 | Hex color applied to the embed sidebar (e.g. #55ff55) | ||||||||||||
fields | List<ShopNotificationField> | — | Fields added to the embed body
|
| Field | Type | Default | Description |
|---|---|---|---|
value | String | {player} | Value shown in the Discord embed field (placeholders supported) |
inline | Boolean | true | Display this field on the same line when possible |
How to use it
This entry only describes how a transaction looks. The channel comes from the shop: set notificationWebhookId on the Shop Definition to the ID of a Webhook Definition. Without this entry, nothing is announced.
shopIdslimits the format to some shops (empty means all). The first entry that covers the shop is used.announceBuys,announceSellsandminimumPricefilter what is posted.- Templates accept
{player},{shop},{item},{amount},{price}and{action}, where{action}isbuyVerborsellVerb.