Gui

How to customize GUIs

How to show the keys in a GUI?

You will need to Shift + Right-click a few times in any GUI (requires the permission songoda.admin) until a chat prompt appears, saying that the keys are now shown. Once you have correctly done this step, you will now have access to view the keys in the GUI. Keys are displayed in purple text directly below the name of the item, in the lore section when you hover over an item in the GUI.

How to generate the GUI file?

You will need to run any command that opens a GUI (Example: "/uf leaderboard"). After running the command, a new folder will be generated in the main folder for that plugin called "GUI" that will hold a file for each GUI that is customizable after you open the GUI at least once in-game.

Different aspects of the file

Key types

Key Type	Description	File
__DEFAULT__	This key is used to edit the background items in a GUI.	overrides: __DEFAULT__: item: RED_STAINED_GLASS_PANE
__ROWS__	This key gives the ability to add more rows to a GUI. (Max 6 rows in total)	overrides: __ROWS__: 6
mirrorfill_<number>	This key is used for all mirrorfills (glass around the border of the GUI). This key requires a special syntax to edit. "mirrorcol:" This option will change all the mirrorfills with that key in the column. "mirrorrow:" This option will change all the mirrorfills with that key in the row.	overrides: mirrorfill_1: item: ORANGE_STAINED_GLASS_PANE mirrorcol: true mirrorrow: true
custom_<name>	This key will allow you to add custom items to the GUI. To add custom items, you must start the key with custom_	overrides: custom_leaderboard_information: item: PAPER row: 0 col: 3 title: '&6Title' lore: - '' - '&eThis gui is meant' - '&eto show the leaderboard' - '&eabout player fishing' Note: Both formats above and below will work. The only difference between them is how the position of the item in the GUI is specified. The first one uses the "row" and "col" variables to specify the position of the item in the GUI, while the second one uses the position "position" variable. overrides: custom_leaderboard_information: item: PAPER position: 3 title: '&6Title' lore: - '' - '&eThis gui is meant' - '&eto show the leaderboard' - '&eabout player fishing'
<key>	This is for any keys that you see in the GUI.In the example below, the item in the GUI with the "weight" key is being edited.	overrides: weight: item: SIGN row: 5 col: 4

How to use the disable function

In this section of the file, you can disable keys. When a key is disabled, all items in the GUI with that key will be removed.

disabled:
- disablekey1
- disablekey2
- disablekey3

How to define the slot position in GUIs

There are two ways to define the position of and item in the GUI.
The first way is by using the position variable.
The second way is by using the row and col variables.

The position variable starts at 0 in the top left corner of GUI.
Below is a small example of code, where the black wool will be placed in the top left corner of the GUI.

overrides:
  custom_code_example_postion:
    item: BLACK_WOOL
    position: 0

The row variable is used to define the row in GUI. In a GUI with 54 slots, the top row will be 0 while the bottom row will be 5. The col variable is used to define the column in the GUI. In every GUI, the columns go from left to right, with the far left column being 0, and the far right column being 8.
Below is a small example of code, where the black wool will be placed in the first row and column of the GUI. So, in the top left corner of the GUI.

overrides:
  custom_code_example_row_and_col:
    item: BLACK_WOOL
    row: 0
    col: 0

Some examples of how you can customize GUIs

In this section, you can find a few examples of what you can do with customization.

This example is a simple remodel of the sell GUI in the plugin UltimateFishing (/uf sell).

disabled:
- mirrorfill_1
- mirrorfill_2
- mirrorfill_3

overrides:
  __DEFAULT__:
    item: RED_STAINED_GLASS_PANE
    
  prices:
    item: BOOK
    row: 0
    col: 1

  accessbaitshop:
    item: STRING
    row: 0
    col: 7

  sellfor:
    item: SUNFLOWER
    position: 4

This example is a remodel of the bait shop GUI from the plugin UltimateFishing (/uf baitshop). Some items were added to the GUI to give players some information about the different bait types.

disabled: []

overrides:
  __DEFAULT__:
    item: RED_STAINED_GLASS_PANE
    
  mirrorfill_1:
    item: ORANGE_STAINED_GLASS_PANE
    mirrorrow: true
    mirrorcol: true
    
  custom_information_about_bait:
    item: SIGN
    row: 0
    col: 0
    title: '&bBait information'
    lore:
    - Bait can be applied
    - when you drag bait
    - on a fish rod
    
  custom_worms_bait:
    item: PAPER
    row: 2
    col: 1
    title: '&bWorms bait information'
    lore:
    - '&eBonus chance: &c100'
    - '&eUses: &c3'
    - '&eTarget: &cTiny and Normal'
    
  custom_ultra_worms_bait:
    item: PAPER
    row: 2
    col: 2
    title: '&bUltra worms bait information'
    lore:
    - '&eBonus chance: &c25'
    - '&eCritical change: &c20'
    - '&eUses: &c3'
    - '&eTarget: &cHuge'
    
  custom_super_worms_bait:
    item: PAPER
    row: 2
    col: 3
    title: '&bSuper worms bait information'
    lore:
    - '&eBonus chance: &c15'
    - '&eCritical change: &c15'
    - '&eUses: &c3'
    - '&eTarget: &cLarge'

This example is a remodel of the leaderboard GUI in the plugin UltimateFishing (/uf leaderboard).

disabled:
- mirrorfill_2

overrides:
  __DEFAULT__:
    item: LIME_STAINED_GLASS_PANE

  weight:
    item: COMPASS

  mirrorfill_1:
    item: GREEN_STAINED_GLASS_PANE
    mirrorrow: true
    mirrorcol: true

  mirrorfill_3:
    item: GREEN_STAINED_GLASS_PANE
    mirrorrow: true
    mirrorcol: true

  mirrorfill_4:
    item: GREEN_STAINED_GLASS_PANE
    mirrorrow: true
    mirrorcol: true

  mirrorfill_5:
    item: GREEN_STAINED_GLASS_PANE
    mirrorrow: true
    mirrorcol: true

  custom_fill_1:
    item: GREEN_STAINED_GLASS_PANE
    row: 0
    col: 3

  custom_fill_2:
    item: GREEN_STAINED_GLASS_PANE
    row: 0
    col: 5

  custom_fill_3:
    item: GREEN_STAINED_GLASS_PANE
    row: 2
    col: 0

  custom_fill_4:
    item: GREEN_STAINED_GLASS_PANE
    row: 2
    col: 8

  custom_fill_5:
    item: GREEN_STAINED_GLASS_PANE
    row: 3
    col: 0

  custom_fill_6:
    item: GREEN_STAINED_GLASS_PANE
    row: 3
    col: 8

  custom_fill_7:
    item: GREEN_STAINED_GLASS_PANE
    row: 5
    col: 3

  custom_fill_8:
    item: GREEN_STAINED_GLASS_PANE
    row: 5
    col: 4

  custom_fill_9:
    item: GREEN_STAINED_GLASS_PANE
    row: 5
    col: 5

Frequently Asked Questions

Here, is the default file when you type the command for the first time.

# All keys on this list will be disabled. You can add any items key here
# if you no longer want that item in the GUI.
disabled:
- example3
- example4
- example5

#
# For information on how to apply overrides please visit
# https://wiki.songoda.com/Gui
#
overrides:

  #
  # This is just an example and does not override to any items
  # in this GUI.
  #
  example:

    # This is the icon material you would like to replace
    # the current material with.
    item: STONE

    # This is the current position of the icon you would like to move.
    # The number represents the cell the icon currently resides in.
    position: 5