Skip to main content

Configuration

All settings are in plugins/HomesGUI-Addon/config.yml. Apply changes with /homesguireload.

Full Config Referenceโ€‹

Commandโ€‹

command:
name: "homesgui"
aliases: ["hgui", "homesmenu"]
enabled: true

Change the command name or aliases here. A server restart is required for command changes to take effect.


GUI Layoutโ€‹

gui:
title: "&6&lYour Homes"
show-borders: true # true = 35 homes/page with decorative border; false = 45 homes/page
homes-per-page-borders: 35
homes-per-page-no-borders: 45
title-color: WHITE
KeyOptionsDescription
show-borderstrue/falseEnables decorative border around home icons
titlestringGUI inventory title (supports color codes)

Home Displayโ€‹

display:
show-coordinates: true # Show X/Y/Z under each home name
show-world-name: true # Show world name in home lore
default-icon: RED_BED # Material used when no custom icon is set
main-home-indicator: "&eโ˜… Main Home" # Text added to lore of the primary home

Custom Iconsโ€‹

custom-icons:
enabled: true

When enabled, players can right-click any home slot to open an icon selection GUI and choose any block or item as their home's icon. Icons are stored per-player in home-icons.yml.


Paginationโ€‹

When a player has more homes than fit on a single page, navigation buttons appear:

pagination:
previous-page-slot: 45
next-page-slot: 53
previous-icon: ARROW
next-icon: ARROW

buttons:
create-home:
enabled: true
slot: 49
icon: LIME_DYE
name: "&a&lCreate New Home"
refresh:
enabled: true
slot: 48
icon: COMPASS
name: "&b&lRefresh"
close:
enabled: true
slot: 50
icon: BARRIER
name: "&c&lClose"

home-icons.ymlโ€‹

This file is auto-managed. Do not edit manually. It stores per-player icon selections:

players:
"uuid-here":
mybase: DIAMOND_BLOCK
farm: HAY_BLOCK

Color Code Referenceโ€‹

CodeColor
&aGreen
&eYellow
&6Gold
&bAqua
&cRed
&lBold
&rReset