GUI Configuration

GUI Configuration (gui.yml)

This page will go over GUI configuration and the different possibilities available to you, including customised lore, sound effects, inventory types, and more.

Links

Please refer to the following links for finding materials, sounds, and player head data:

Materials
Sounds
Player Head Data

---

config Section

Setting	Description	Values
main-inventory	The inventory that will be opened when running /chatcolor gui.	Any inventory name. Default: main
select-sound	A sound played when a player successfully selects a colour or modifier.	Any valid Sound. Default: BLOCK_AMETHYST_BLOCK_STEP
error-sound	A sound played when a player fails to select a colour, or an error occurs.	Any valid Sound. Default: ENTITY_BLAZE_HURT
filler-item-material	The material used to fill empty spaces in the GUI, where applicable.	Any valid Material. Default: LIGHT_BLUE_STAINED_GLASS_PANE
no-permission-item	The item displayed in place of items when a player doesn't have permission.	material is any valid Material, lore is a YAML list of text that you want to appear. Default material: BARRIER Set material to NONE if you do not want it to appear in the inventory.
color	selected-text is a line of lore added when a colour is currently selected, unselected-text is for all other colours.	Any text value
modifier	selected-text and unselected-text are the same as for color. selected-material and unselected-material are the materials used for selected/unselected modifiers.	Any text value & any valid Materials

Inventory Configuration

You can define any number of inventories within the GUI config, each having its own unique name. The default inventories included with the plugin are called main, hex, and custom. Please refer to the table below when creating your own inventories:

Setting	Description	Values
title	A title for the inventory.	Any text value, supporting all colour codes & custom colours, e.g. &g[a,b,c]Inventory Title or %hotInventory Title
size	The size of the inventory.	A multiple of 9, e.g. 27, 36, 45
fill-empty-slots	If set to true, then all empty slots in the inventory will be filled with the FILLER item type.	true or false
inventory-type	Controls how items appear in the inventory.	STATIC if all items should have a fixed position, or DYNAMIC if you want to group visible items together.
items	This is where you configure the items to be shown in the inventory.	Each item must be in the format shown below.

Item Configuration

Setting	Description	Values	Required?
<slot>	The number of the inventory slot to place the item in.	0 to <inventory size - 1>	Yes
type	The type of item.	COLOUR, MODIFIER, FILLER, or INVENTORY	Yes
data	The data relating to the item.	The inventory name, colour, or modifier.	Yes, except FILLER items.
name	The display name of the item. This is auto-generated from the colour/modifier if not set.	Any text value.	Yes, for INVENTORY items.
material	The Material of the item.	Any valid Material.	Yes, for COLOUR and INVENTORY items.
head-data	The base-64 encoded texture value for a player head.	A valid base-64 texture, see the links at the top for where to get this from.	Yes, for any item using PLAYER_HEAD as a material.
lore	A list of text lines to display as lore on the item.	Any text values in a list format.	No
no-permission-lore	A list of text lines to display as lore if the player doesn't have permission for the item.	Any text values in a list format.	No

---

The config file also has guidance at the top, but if you have any further questions, feel free to join the support server here!