Configuration Guide

Configuration List Table

Main

Config	information	note	type	default
enabled	Toggles the entire plugin feature	-	boolean	true
luckperms-formatting	Toggles LuckPerms chat.	-	boolean	false
chat-format	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	false
replace-all	Replace all "[item]" tags in chat	if false, only the first "[item]" text will be replaced	boolean	"{prefix} {player}: {message}"
amount-tag-format	<cis_amount_tag> format	refer the text-format below	string	" x<cis_amount_number>"
define-vanilla-sprites	Vanilla item sprite definitions	use this for unsupported items like shield, banner. detail described in Atlas & Sprite Guide	list(string)	only examples are written
define-custom-item-sprites	Custom item sprite definitions	use this for custom items. detail described in Atlas & Sprite Guide	list(string)	only examples are written

---

item

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

---

text-format

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

Display Mode	default message	note
"both"	<gray>[<reset><cis_sprite> <cis_name><cis_amount_tag><gray>]	-
"sprite-only"	<gray>[<reset><cis_sprite><gray>]	-
"text-only"	<gray>[<reset><cis_name><cis_amount_tag><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

---

Modes

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)

Custom tags for text-format and amount-tag-format

• <cis_sprite> - print sprite as MiniMessage (works properly in "both", "sprite-only")
• <cis_name> - print localized item name (works properly in "both", "text-only")
• <cis_amount_tag> - print amount-tag-format (works properly in "both", "sprite-only", "text-only")
• <cis_amount_number> - print item's amount, ONLY in amount-tag-format (<cis_amount_tag>)
• [DEPRECATED] <cis_amount> - print item's amount. (hide-amount-when-one WON'T WORK. works properly in "both", "sprite-only", "text-only")

Sprite Definitions

see Atlas & Sprite Guide.