Configuration Guide

Configuration List Table

Main

Config	information	note	type
enabled	Enable or disable the entire plugin feature	-	boolean
luckperms-formatting	Chat format with LuckPerms prefix.	LuckPerms prefix with legacy formatting code still works like LuckPerms, but this plugin will never support legacy formatting code in messages.	string
replace-all	Replace all [item] tags	if false, only the first [item] text will be replaced	boolean
define-vanilla-sprites	Vanilla item sprite definitions	use this for unsupported items like shield, banner. detail described in Format section	list(string)
define-custom-item-sprites	Custom item sprite definitions	use this for custom items. detail described in Format section	list(string)

---

item

Config	information	note	type
display-mode	Item display format	detail described in Format section	string (both, sprite-only, text-only)
unsupported-vanilla-item-fallback	Format for unsupported vanilla items	player head, shield etc.	string (text, none)
unsupported-custom-item-fallback	Format for unsupported/texture-missing custom items	detail described in Format section	string (raw, text, none)
show-hover-info	Show hover tooltip with full item info	-	boolean

---

text-format

information: Display format of item in chat. Normally, they follow config-item's display-mode.

Display Mode	default message	note
"both"	<gray>[<reset><cis_sprite> <cis_name> x<cis_amount><gray>]	-
"sprite-only"	<gray>[<reset><cis_sprite><gray>]	-
"text-only"	<gray>[<reset><cis_name> x<cis_amount><gray>]	-
"fallback-none"	<gray>[<reset>?<gray>]	when item fallback happens with fallback none mode
empty-hand-format	<gray>[<reset>Empty Hand<gray>]	when player is holding nothing

---

Format

display-mode

For default, display-mode is "both". For this case, item on chat displays "both" text format. But if <cis_sprite> is null, display-mode is ignored and follow unsupported-vanilla-item-fallback or unsupported-custom-item-fallback. Fallback has 3 methods:

• "raw": (only in custom item fallback) Displayed raw material's sprite by "sprite-only" format
• "text": display item as "text-only".
• "none": display fallback-none (still hovered with show-hover-info)

Sprite Definitions

wip