-
Notifications
You must be signed in to change notification settings - Fork 0
GUI Configuration
Soapiee edited this page Mar 16, 2026
·
3 revisions
If you need a clean copy of the config, get it here
info_icon:
type: block
value: player_head
display_name: "&2Your biome info"
slot: 4
lore:
- ""
| Field | Description | Default |
|---|---|---|
type: |
Valid options: block or texture (NOTE: Textures will be added in version 1.0.9) |
"block" |
value |
This must be a valid Bukkit Material. If value is player_head, it will be the head of the player looking at the gui |
"GRASS_BLOCK" |
quantity: |
Set the amount of items. If its a biome icon, the quantity will be set to the players level of that specific biome | 1 |
slot: |
Unless stated other wise, enter a single integer for the slot. Set to -1 to hide the icon. |
null |
display_name: |
Set a name for the icon, you can use minecraft and hex codes here. This can be left blank. | null |
lore: |
Set a lore for the icon, you can use minecraft and hex codes here. Use a list to create the lore. This can be left blank. | null |
These are the navigation buttons that are used in every GUI page. See above on how to format them.
next_page:
type: block # Valid types: block, texture
value: SPECTRAL_ARROW
display_name: "&eNext Page (%next_page_number%)"
slot: 50
prev_page:
display_name: "&ePrevious Page (%prev_page_number%)"
...
close:
...
| Placeholders | Description |
|---|---|
%next_page_number% |
Will return the number of the next page |
%prev_page_number% |
Will return the number of the previous page |
These are the settings and icons that are shown in the every page.
title: "#1baecf&lBiome Info"
size: 54
info_icon:
slot: 4
...
filler_icon:
type: block
value: LIME_STAINED_GLASS_PANE
slot: [ 0, 1, 2, 3, 5, 6, 7, 8, 9, 17, 18, 26, 27, 35, 36, 44, 45, 46, 47, 51, 52, 53 ]
display_name: "&8"
default_biome_icon:
slot: [ 10, 12, 14, 16, 20, 22, 24, 28, 30, 32, 34, 38, 40, 42 ]
...
default_reward_icon:
slot: [ 10, 12, 14, 16, 20, 22, 24, 28, 30, 32, 34, 38, 40, 42 ]
...
| Field | Description | Default |
|---|---|---|
title: |
Set the title of the GUI, you can use minecraft and hex codes here. | null |
size |
The total amount of slots in the GUI. Must be a multiple of 9 | 54 |
slot: |
For the filler_icon, default_biome_icon and default_reward_icon, you can have multiple slots. Format it the same as above, or in a verticle list. Set to -1 if you do not want any |
null |
| Placeholders | Usage | Description |
|---|---|---|
%biome% |
default_biome_icon, default_reward_icon and specifically defined biomes |
Will return the biome string |
%level% |
default_biome_icon, default_reward_icon and specifically defined biomes |
Returns the players current level of that biome |
%reward% |
default_reward_icon |
Shows the reward string |
%reward_status% |
default_reward_icon |
Returns if the player can or cannot claim this reward. If the reward has been reached and its multi-use, it will display if the reward is active or not |
%progress% |
default_biome_icon and specifically defined biomes |
Shows the progress value of their current level |
%progress_bar% |
default_biome_icon and specifically defined biomes |
Shows a progress bar of their current level |
Here you can change individual icons for specific biomes. Set this in the "biomes" config section, just like where you set the unique level rewards for specific biomes.
biomes:
FOREST:
gui:
type: block
value: oak_sapling
display_name: "&b%biome%"
lore:
- ""
- "&bLevel: %level%"
- "&bProgress: %progress%"
- ""
- "&fClick for reward details"
levels:
...
This is an example of how to use a texture/custom head as an icon
next_page:
type: texture
value: eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYTBjYmRhYmI3MmE3ZmExZGZkNTk4NTQ1YmNmNGRhNTNhM2FmNzRhYzhhNzM5ZDM5Yzk2ZWFhNDc1YTA5YzJkNyJ9fX0=
display_name: "&eNext Page (%next_page_number%)"
slot: 50
This is an example of a website where you can browse custom heads and one that gives you the full texture string: https://minecraft-heads.com/custom-heads/head/125501-arrow-right
On this website you would want to copy the text in the "value" box.