GUI Configuration
ECS has a very customizable GUIs. However this power comes with a certain "responsibility". Moving items around may cause problems with future updates. When we add new items, increase the size of the GUI or similar, we might mess with your custom layout. For that reason we implemented a system to warn you if Items are overlapping or are outside of the GUI bounds. Simply changing the type of a item will however cause no problems. Only moving items or changing the GUI size can cause extra work for you in the future.
To access the ingame GUI editor, you can use the command /ecsadmin configure-guis. This will open a GUI that allows you to select which GUI you want to edit.
When selecting a GUI to edit, you'll get to a overall GUI option screen:
- Chest - allows you to edit the GUI.
- Black Stained glass (center of the gui, below the middle paper) - clicking this button will open the Background selector.
- Rail - left clicking decreases the amount of rows in the gui, while right clicking increases the row count.
- Arrow - return to main menu
In this view you can add/remove/modify/move around all GUI items. The controls for each field are displayed when you hover over the individual items. Some items may overlap, like the toggle buttons or the different storage display buttons. These won't throw any warnings and you can cycle through them via Right clicking.
Via left clicking you can edit the currently hovered item. This will allow you to change the item type & amount and if the item has a enchanted glow effect. To change the item, simply select a item from your inventory and it's type & amount will be automatically detected. Please keep in mind that this editor is rather simplistic at the moment, so items with custom data like player heads or potions with specific colours will only render in their default state. If you want to improve our editor, feel free to submit a Pull Request to implement the feature you'd like to use.
In the GUI Editor, wherever you press F, you can add a item. You will always be able to add decorative items. These items have no button like interactions and simply allow you to decorate your GUIs. Additionally the GUI will include items that are currently not part of the GUI. This will most likely be because the item has been deleted at some point.
Here is a example of custom Items being used to customize the shop GUI. The black stained glass is a placeholder for Air blocks, which can also be selected as the background. Keep in mind that this GUI has extra items, is missing the custom amount buy/sell item and has more slots, which may lead to extra work in the future, when we modify the GUI with new options.
The config editor is harder to read and may in some cases take longer (or sometimes shorter) to edit. It also includes some special item options.
- Custom rotation values:
hologram-rotation-up/north/east/south/west/downhologram-rotation-allis the default item, which covers all use cases. Either useallor all of the individual values. - Custom buy/sell amounts! You can define how many items are sold/bought with the individual buttons:
(sell/buy)-1/2/3/4/.../1728/all/maxStackSize, whereallwill calculate the maximum amount a player can buy/sell at the moment, calculated via the available shop/player storage and available shopowner/player balance.maxStackSizemeans the amount this item would naturally stack to (e.g. blocks x64, ender pearls x16, tools x1).
There are some other special cases, like the hologram-message-item or transaction-logs item, which are replicated over many slots in the GUI and therefore do not have a slot allocated in the GUI. Or the shop item, which does not have a material, since it will be applied per shop. Check here for the current config which includes comments that show all special options.
As mentioned before, GUIs are easy to break and hard for us to future proof while still giving you all the freedom. Whenever we
- change the arrangement of items
- add new items
- remove items
- change the size of the GUI
your customized GUIs are in danger of being distorted. Whenever we update our GUIs or config files, we attempt to make upgrading as smooth as possible, however we can only guarantee that for the default GUI. But don't fear to express your server in your shops! When we update the shops and something breaks, we are sending you a notification should a) a item be invisible because your GUI is too small or b) your items overlap each other, causing one of them never to appear.
Should this problem arise, the message above tells you where and which items are overlapping, as well as which GUIs have overflowing items. You can fix this pretty easily via modifying the broken gui with /ecsadmin configure-guis. For a detailed guide, see the content above regarding the ingame editor!
If you never touch the GUI config, we can guarantee you won't ever have to worry about them! Also, changes to individual items like the material, or if it is glowing won't cause problems. Changing the layout or slots of a GUI is however a category that might lead to future work. So if you use a custom GUI, always check the GUIs when you update the plugin on your server to make sure everything is still alright!