Skip to main content

🖥️ GUI Customization

EventForge includes GUI configuration options in config.yml.

In v1.0.1, GUI titles can be customized and common button config has been added for future layout expansion.

info

Current menus still use fixed 6-row layouts. The gui.rows option is reserved for future layout updates.


Basic config

In plugins/EventForge/config.yml:

gui:
enabled: true
rows: 6

titles:
player-main: "&b&lEventForge"
player-active: "&b&lActive Events"
player-scheduled: "&b&lScheduled Events"
player-stats: "&b&lYour Event Stats"
player-history: "&b&lEvent History"
player-details: "&b&lEvent Details"

admin-main: "&c&lEventForge Admin"
admin-start: "&c&lStart Event"
admin-stop: "&c&lStop Event"
admin-loaded: "&c&lLoaded Events"
admin-schedules: "&c&lSchedules"
admin-history: "&c&lEvent History"
admin-details: "&c&lEvent Details"
admin-confirm-reload: "&c&lConfirm Reload"

buttons:
filler:
material: BLACK_STAINED_GLASS_PANE
display-name: " "
close:
material: BARRIER
display-name: "&cClose"
back:
material: ARROW
display-name: "&eBack"
previous-page:
material: ARROW
display-name: "&ePrevious Page"
next-page:
material: ARROW
display-name: "&eNext Page"
info:
material: BOOK
display-name: "&bInfo"
empty:
material: GRAY_STAINED_GLASS_PANE
display-name: "&7Empty"

Enable or disable GUIs

gui:
enabled: true

Set this to false if you do not want players using EventForge GUIs.

gui:
enabled: false

GUI rows

gui:
rows: 6
warning

gui.rows is currently reserved for a future layout update.

Current EventForge menus still use 6 rows for safety.

Do not rely on this option to resize menus yet.


GUI titles

You can customize GUI titles:

gui:
titles:
player-main: "&b&lEventForge"
player-active: "&b&lActive Events"
admin-main: "&c&lEventForge Admin"

Colour codes using & are supported.

Example:

player-main: "&3&lServer Events"
player-active: "&bActive Competitions"
admin-main: "&c&lEvent Admin"

Player menu titles

KeyUsed for
player-mainMain player event menu
player-activeActive events menu
player-scheduledScheduled events menu
player-statsPlayer stats menu
player-historyEvent history menu
player-detailsEvent details menu

Admin menu titles

KeyUsed for
admin-mainMain admin menu
admin-startAdmin start menu
admin-stopAdmin stop menu
admin-loadedLoaded events menu
admin-schedulesAdmin schedules menu
admin-historyAdmin history menu
admin-detailsAdmin event details menu
admin-confirm-reloadReload confirmation menu

Button config

EventForge includes common button config sections:

buttons:
filler:
close:
back:
previous-page:
next-page:
info:
empty:

This structure exists so common buttons can be expanded further in future updates.

info

In v1.0.1, GUI title customization is the main implemented GUI config feature. Button config is present for future expansion and consistency.


Reloading GUI config

After changing GUI config, reload EventForge:

/eventforge reload

If your setup uses reload confirmation, follow the confirmation prompt.

For large config changes, restarting the server is always safest.


Troubleshooting

GUI title did not change

Check:

The config key is correct
The YAML spacing is valid
You reloaded EventForge
You are opening the correct menu

GUI does not open

Check:

gui.enabled is true
The player has permission
EventForge loaded correctly
There are no console errors

Custom rows do not work

This is expected in v1.0.1.

gui.rows is currently reserved for a future layout update. Menus still use 6 rows.

Button items did not change

In v1.0.1, button config is not fully applied across every menu yet.

The common button structure is included for future expansion.