WG-GUI

This release contains major changes to configuration files. I recommend making backup of your existing WG-GUI installation before performing update.

 

This release is confirmed to work on Minecraft servers versions from 1.13 to 26.1.

 

 

After creation of region, player was automatically moved to template selection for that region – this is now controllable. Furthermore, if no templates are available, plugin will move players to„Region options” menu instead. This behavior is also controllable with following settings in config.yml:

 

# If true, after creating region player will be moved to "Select template" menu of that region.
AutoOpenRegionTemplateSelectAfterCreation: true
# If true, after creating region player will be moved to "Region options" menu of that region.
# This option has lower priority than 'AutoOpenRegionTemplateSelectAfterCreation' option and if both are enabled then this one has effect only when player doesn't have permission required to enter 'Select template' menu or no templates are available.
AutoOpenRegionOptionsAfterCreation: true

 

 

When both settings are disabled, plugin won’t perform any further action to player after region creation.

 

 

config.yml file:

 

# If true, player will need specific permission to see region templates in "Select template" menu and use them when creating/editing region. If false, all templates will be visible and usable for all players.
# Permission node format: wggui.user.template.<templatename> (e.g. wggui.user.template.pvp)
RegionTemplatesUsePermissions: true

 

 

 

Added 2 ways to control access to worlds in „Select world” inventory. First one uses permissions, second one disables world completely from being accessed using WG-GUI for all users.

# If true, player will need specific permission to see worlds in "Select world" menu. If false, all worlds will be visible to all players.
WorldsUsePermissions: true

 

 

When enabled, player needs „wggui.worlds.<world_name>” permission to have access to given world

# This option excludes worlds from being shown in "Select world" menu for all players, even those with permissions to see all worlds.
ExcludedWorlds:
- "myworld"

 

 

 

Plugin now checks worlds player has access to when working with „Edit existing region”, „Set parent region” and „Copy flags from other region” options.. If they have access to only one world, they won’t see „Select world” menu and instead will see „Select region” menu for that world. This works only when „MoveToSelectRegionMenuWhenOnlyOneWorldAvailable”  is set to true in config.yml (by default it is).

 

When player has access to only one world and to only one region in that world, after clicking on „Edit existing region” they will be moved to „Region options” menu for that region. This works only when „AutoSelectRegionWhenOnlyOneAvailable” is set to true in config.yml (by default it is).

 

When exiting from „Region options” menu, plugin moves player directly to main menu if  AutoSelectRegionWhenOnlyOneAvailable is set to true and player has access to only one world and to only one region in that world.

 

config.yml:

 

# If true, when player clicks on "Edit existing region", "Copy flags from other region" or "Set parent region" item and they're allowed to edit regions in only one world, they will be moved directly to "Select region" menu for that world instead of "Select world" menu.
MoveToSelectRegionMenuWhenOnlyOneWorldAvailable: true
# If true, when player clicks on "Edit existing region" item and they're allowed to edit only one region in one world, they will be moved directly to "Region options" menu for that region instead of "Select world/region" menu.
AutoSelectRegionWhenOnlyOneAvailable: true

 

 

Above settings don’t affect players with permission to edit regions they don’t own - they will always see „Select region” menu no matter what.

 

 

It’s now possible to unset current parent region – to do so, right-click „Set parent region” item in Region Options menu.

 

 

Added support for modern text formatting in chat and inventories (uses MiniMessage and requires server running Paper version minimum 1.17 or compatible fork. This applies to all files where user can edit text (lang.yml, region_templates.yml, flag_descriptions.yml). By default this feature is enabled on supported servers when WG-GUI runs for the first time on server; to disable it, set „ModernChatFormatting” to false in config.yml file. If you’re updating an existing WG-GUI installation, this feature will not be automatically enabled.

 

# Use MiniMessage tags (<white>) instead of legacy color codes ('&f') to format chat messages
# Requires Paper 1.17+ or compatible fork
# https://docs.papermc.io/adventure/minimessage/format/
ModernChatFormatting: false

 

 

Note: To switch from legacy to modern format (or vice versa), after changing setting in config.yml it’s also needed to delete existing lang.yml, region_templates.yml and flag_descriptions.yml files from inside of WG-GUI folder. If you have modified these files (e.g. changed colors), backup them before proceeding. These changes have to be done when plugin is disabled, doing it with only /wggui reload comand was not tested and I don’t guarantee this will work without issues.

 

 

It’s now possible to edit all items’ materials displayed in inventories (previously only 6 items were modifable). This is done in config.yml file:

 

Items:
 GuiItem: CLOCK
 FlagItem: REDSTONE_TORCH
 RegionItem: END_CRYSTAL
 WorldItem: GRASS_BLOCK
 OwnerMemberItem: TOTEM_OF_UNDYING
 ExitItem: REDSTONE_BLOCK
 PageItem: ARROW
 CreateNewRegionItem: DIAMOND_AXE
 EditExistingRegionItem: WOODEN_SHOVEL
 EditLastModifiedRegionItem: GOLDEN_SHOVEL
 ReloadConfigItem: WRITABLE_BOOK
 RegionVisibilitySwitchItem: LEVER
 EditRegionFlagsOptionItem: REDSTONE_TORCH
 SelectRegionTemplateOptionItem: ENCHANTED_BOOK
 EditRegionBoundariesOptionItem: WOODEN_AXE
 CopyFlagsFromOtherRegionOptionItem: MAGMA_CREAM
 SetRegionParentOptionItem: CLOCK
 RenameRegionOptionItem: NAME_TAG
 RemoveRegionOptionItem: LAVA_BUCKET
 EditRegionFlagsHelpItem: PAPER
 AddRegionMemberItem: LIME_TERRACOTTA
 AddRegionOwnerItem: LIME_TERRACOTTA
 RemoveRegionMemberItem: RED_TERRACOTTA
 RemoveRegionOwnerItem: RED_TERRACOTTA

 

 

wggui.command.help (required to access /wggui help command)
wggui.command.reload (required to access /wggui reload command)
wggui.user.owners.multiple (required to set more than 1 owner in region)
wggui.worlds.<world> (used to access worlds if feature enabled, explained above)

 

 

 

 

WG-GUI now runs concurrently on over 100 servers worldwide. I’m glad to see this number constantly increasing, this shows that community appreciates tools like this improving work with one of most crucial plugins on Minecraft servers. WG-GUI is full of potential and I’m thinking about many more improvements to bring you in future updates. If there is something you would like to see in next update, let me know! If you find any bugs in this release, also tell me about it.

 

The most time consuming part during development of this update was refactoring about 90% of existing codebase. This opened a way to a much more painless plugin scaling and features expanding.

 

I expect to release at least one more major update during second half of this year (or split it into a couple smaller updates).

Potential bug fixes and Minecraft version specific compatibility updates are being released when needed and as soon as possible.