GUIs
There are a few GUIs in the plugin: Build GUI and its children, Subject GUI, Team GUI, Spectator GUI, Arena GUI and several Mob GUIs. They're explained below.
The build GUI is the GUI that you can use while building in-game. It contains 6 children for various actions: Particle GUI, Floor GUI, Time GUI, Rain (not a GUI), Fly Speed GUI and the Head GUI. You can open it by clicking on the emerald inside your inventory.
You can customize the slot the emerald appears on and if it should appear at all. You can find these settings in the config.yml, listed as gui > slot and gui > enable.
Here you can choose to place particles on the plot and remove all particles if you want to. To prevent overloading the server with particles you can set a limit in the config.yml, listed as max-particles. Set this to the maximum amount of particles.
You can change the particles themselves as well by changing their amount and their offset on all three axes. Go into the config.yml and look for particles. There you can find the amount setting and the offset setting with the x, y and z axes listed.
The icon for the particle can be changed in the config.yml, listed as gui > particles > id. You can also disable the category completely by changing gui > particles > enable.
The permission bg.buildmenu.particles is required to be able to view this GUI.
This is a two in one item. By clicking on it with a block you will immediately replace the entire floor with the block you have in your cursor. The second option is clicking on it with an empty cursor. This will lead you to a GUI with all blocks listed.
You can however limit the blocks that will be shown / can be used in the config.yml. Go to gui > floor > excluded-blocks and add/remove blocks there. Those blocks won't show in the GUI anymore and can't be used with the first option either. You blocks listed under blocks > blocked in the config.yml will also be respected.
If you want to prevent the floor from changing too often you can set a cooldown in the config.yml as well. Go to gui > floor > cooldown. The value is in seconds, but the value can hold a value as precise to 1 ms.
You can also change the item shown in the GUI and disable the category completely by going to gui > floor in the config.yml. There you can find id and enable for these settings.
The permission bg.buildmenu.floor is required to be able to view this GUI.
Here you can change the time that will be displayed on your plot. This will only affect the time for players on that specific plot and won't change anything for the others.
You can change the item shown in the GUI and disable the category in the config.yml. Go to gui > time, and then to id and enable.
The permission bg.buildmenu.time is required to be able to view this GUI.
This isn't a GUI, but is worth mentioning. With this you can toggle whether it rains or not on your plot.
You can change the item shown in the GUI and disable the category in the config.yml. Go to gui > rain, and then to id and enable.
The permission bg.buildmenu.rain is required to be able to interact with this setting.
With this GUI you can change the speed with which you fly. You can set it to 1 (default), 2, 3, 4 or 5, where each one is the amount of times faster than normal.
You can change the item shown in the GUI and disable the category in the config.yml. Go to gui > fly-speed, and then to id and enable.
The permission bg.buildmenu.flyspeed is required to be able to view this GUI.
The heads GUI allows you to access over 500+ custom heads to use on your plot. It's divided into 11 categories which will be explained below.
All heads come from this website, so here you can find a list of all the heads.
You can change the item shown in the GUI and disable the category in the config.yml. Go to gui > heads, and then to id and enable.
The permission bg.buildmenu.heads is required to be able to view this GUI.
The first category is food. This category contains 100+ food related heads across multiple pages.
The permission bg.buildmenu.heads.food is required to view this category.
The second category is devices. This category contains 25+ device related heads across multiple pages.
The permission bg.buildmenu.heads.devices is required to view this category.
The third category is miscellaneous. This category contains 50+ miscellaneous related heads across multiple pages.
The permission bg.buildmenu.heads.misc is required to view this category.
The fourth category is alphabet. This category contains 100+ alphabet related heads across multiple pages.
The permission bg.buildmenu.heads.alphabet is required to view this category.
The fifth category is interior. This category contains 25+ interior related heads across multiple pages.
The permission bg.buildmenu.heads.interior is required to view this category.
The sixth category is colors. This category contains 25+ color related heads.
The permission bg.buildmenu.heads.colors is required to view this category.
The seventh category is blocks. This category contains 100+ block related heads across multiple pages.
The permission bg.buildmenu.heads.blocks is required to view this category.
The eighth category is mobs. This category contains 25+ mob related heads across multiple pages.
The permission bg.buildmenu.heads.mobs is required to view this category.
The ninth category is games. This category contains 25+ game related heads.
The permission bg.buildmenu.heads.games is required to view this category.
The tenth category is characters. This category contains 50+ character related heads across multiple pages.
The permission bg.buildmenu.heads.characters is required to view this category.
The eleventh category is Pokémon. This category contains 100+ Pokémon related heads across multiple pages.
The permission bg.buildmenu.heads.pokemon is required to view this category.
With this GUI you can easily create banners and even create banners with more than six patterns. You can specify the default color, and any patterns.
You can change the item shown in the GUI and disable the category in the config.yml. Go to gui > banners, and then to id and enable.
The permission bg.buildmenu.banners is required to be able to view this GUI.
With this GUI you can change the biome of your plot. The effects of this will only be visible to players who are playing and spectators, so people from outside won't notice anything. It's recommended to have a decent connection to the server when changing the biome, cause the chunks need to be fully reloaded in order for this to work. There are currently sixteen different biomes to choose from.
You can change the item shown in the GUI and disable the category in the config.yml. Go to gui > biome, and then to id and enable.
The permission bg.buildmenu.biome is required to be able to view this GUI.
The subject GUI contains a list of subjects all players can vote on. The subject with the highest amount of votes will be picked as the theme for the first match, unless the theme is overridden by executing /bg forcetheme <theme>. When multiple subjects received the same amount of votes, one of those will be picked at random.
The subject GUI can only be used the first match to vote on a theme. When a game contains more than one match, the matches after the first one will use a randomly chosen theme.
The subjects shown in the GUI are directly connected with the subjects list in the config.yml. The subjects entered in that list will be shown in the GUI. Whenever there are too many subjects to show on one page, next page and previous page items will be available to navigate to different pages.
The amount of subjects in the GUI can be limited by setting subject-gui > subject-amount to the desired amount of subjects that should be shown in the GUI. Setting this to -1 will show all the subjects.
The item used for opening the subject GUI can be changed in the config.yml under subject-gui > item > id, and the position of the item can be changed with subject-gui > slot.
Subject voting can be disabled in the config.yml be setting enable-subject-voting to false.
The team GUI allows you to pick the team you want to be one. This feature is only available in a team game and not in solo games. The GUI will show a list of teams and clicking one of them will move you to the desired team.
The items shown for the teams can be changed in the config.yml under team-selection > team > the team number > id. This list is expanded to the amount of teams the plugin has. So an arena with ten teams means that the config.yml will be expanded to include those ten teams. If you'd like to change the items prior to creating the teams, or adding them in case you want to expand your arenas in the future, can be done by adding these sections manually yourself. Add a new section with the team number you want to set the item for in single quotes ('5'). Then add id to that section and enter the item id you want to show in the GUI.
The items in the GUI will show a list of player names who are already on the team by default, however you can opt out of this and add your own list of messages in the messages.yml. You can disable this in the config.yml under team-selection > show-names-as-lore. The new list of messages will be retrieved from the messages.yml under team-gui > team > lores.
The item used for opening the GUI can also be changed in the config.yml under team-selection > item > id.
The spectator GUI is a simplified version of the build GUI, but now for spectators. This GUI only contains the fly speed option to change the fly speed for spectators. This behaves the same way as the fly speed GUI so for more information, check out the fly speed section
This GUI will show a list of all open arenas which can be joined by a player. It'll be shown whenever the player doesn't mention the arena name the want to join inside the join command (/bg join [name]).
These GUIs serve to easily modify mobs, like color, style, age, etc. The GUI can be opened by right clicking on an entity on your plot. Depending on the mob, different options may appear. Some mobs can only be removed, others have a variety of options.