Configuration

DisplayItem Configuration

The following settings are available for DisplayItem in the plugin's configuruation file (plugins/DisplayItem/config.yml). All settings are children of the main "displayitem" section and should be indented properly when using them.

Configuration can be reloaded without restarting the server by a user with the correct permission by using the /direload command.

Newer snapshots of the plugin have an experimental and interactive /dicalibrate command which may help you choose event and priority options that work best with your existing plugins.

The default configuration can be found here. Below is a description of each setting.

• metareplacement - set the text that shows in chat as the 'replacement' string itself (as below), to allow posting it in chat - may not contain the replacement string itself. (default: [I]) (eg: [I] will display [i])
• replacement - set the text that is replaced with the held item - may not contain the meta replacement string
• itemformat - how the item should appear in chat (using formatting codes and replacements) (default: [i])
• itemtoolongformat - how the item should appear when it has too many tags to safely display (see jsonlimit)
• usebooknameformat - enable or disable book names showing in chat (shows Written Book if disabled) (default: true)
• booknameformat - how the book name should appear (using formatting codes and replacements)
• overridechatformat - whether to force a particular chat message format or keep the bukkit-event-provided format (default: false)
• format - how the chat message line should appear (using formatting codes and replacements)
• spamdetectionbuffer - how many item-display records history to keep for detecting spam
• spamthreshold - sets within how many miliseconds a post in the history is considered spam (Default: 2000)
• spamdetectionsresetcooldown - sets whether the detection cooldown (threshold) resets to full when they trigger the spam detection. v2.5+ (default: false; in lower versions the behavior is always 'true').
• jsonlimit - sets an upper limit on the amount of JSON characters for the item to have a hover component Default: 10000
• listenerpriority - sets the priority at which DisplayItem captures chat messages (lower=before other plugins) Default:NORMAL. Note: can only have values: LOWEST, LOW, NORMAL, HIGH, HIGHEST.
• sendmodifiedchatevent - whether or not to send a ReplacedChatEvent out of courtesy to other plugins. Default: true
• messages: - section of messages displayed by DisplayItem
• • cooldown - message displayed to a user when the item-replacement is detected as spam. (using formatting codes [and replacements v2.4+])
• integrations: - section of settings that allow DisplayItem to integrate with other plugins, if supported.
• • placeholderapi - controls whether DisplayItem allows PlaceholderAPI expansions in format strings. (default: true, v2.4+)