Reward_GUI.json

Reward_GUI.json

The layout and look of the /dex rewards GUI. Located at config/DexRewards/reward_gui.json. One layout is shared by every dex type.

Note

• All text uses MiniMessage formatting.
• Text can use Dex Type and Player placeholders, which read from the open dex type and the viewing player. Group items can also use Reward Group placeholders.
• Missing keys are added with their default values the next time the file loads.

📄 Full default file

{
  "title": "<gold><bold>%dex_type% Rewards",
  "use_hopper_gui": false,
  "rows": 6,
  "gui_layout": [
    "#########",
    "####I####",
    "#GGGGGGG#",
    "#GGGGGGG#",
    "#GGGGGGG#",
    "P###C###N"
  ],
  "background_item": {
    "symbol": "#",
    "item": {
      "id": "minecraft:gray_stained_glass_pane"
    },
    "item_name": "",
    "item_lore": []
  },
  "previous_item": {
    "symbol": "P",
    "item": {
      "id": "minecraft:arrow"
    },
    "item_name": "<gray>Previous",
    "item_lore": []
  },
  "next_item": {
    "symbol": "N",
    "item": {
      "id": "minecraft:arrow"
    },
    "item_name": "<gray>Next",
    "item_lore": []
  },
  "close_item": {
    "symbol": "C",
    "item": {
      "id": "minecraft:barrier"
    },
    "item_name": "<gray>Close",
    "item_lore": []
  },
  "player_info_item": {
    "symbol": "I",
    "item_name": "<light_purple>%dex_type% Progress Info",
    "item_lore": [
      "<gray>Latest Reward: %player_reward_group%",
      "<gray>Progress: %player_dex_count%/%pokedex_total% (%player_dex_percent%%)"
    ]
  },
  "group_item": {
    "symbol": "G",
    "claimed": {
      "item_name": "<green><bold>%group_name% (%group_percent%%)",
      "item_lore": ["<blue>Already Claimed!"],
      "show_enchantment_glint": false
    },
    "claimable": {
      "item_name": "<gold><bold>%group_name% (%group_percent%%)",
      "item_lore": ["<green>Claimable!"],
      "show_enchantment_glint": true
    },
    "locked": {
      "item": {
        "id": "minecraft:barrier"
      },
      "item_name": "<red><bold>%group_name% (%group_percent%%)",
      "item_lore": ["<red>Not Unlocked!"],
      "show_enchantment_glint": false
    }
  }
}

Top Level

Field	Type	Default	Description
title	string	—	The GUI's title.
use_hopper_gui	boolean	false	Use a 5-slot hopper GUI instead of a chest. rows is ignored when this is true.
rows	integer	6	Number of chest rows, from 1 to 6. Any other value uses 6.
gui_layout	list	—	One string per row, one character per slot: 9 characters per row for a chest, 5 for a hopper. Each character is an element's symbol. See Layout.
background_item	object	—	Fills empty space. See Elements.
previous_item	object	—	Goes to the previous page.
next_item	object	—	Goes to the next page.
close_item	object	—	Closes the GUI.
player_info_item	object	—	Shows the player's head with their progress.
group_item	object	—	A slot for one reward group. See Group Items.

Layout

Each character in gui_layout places an element by its symbol. With the default layout, the 21 G slots show 21 reward groups per page:

#########     # = background
####I####     I = player info
#GGGGGGG#     G = reward group
#GGGGGGG#     P = previous page
#GGGGGGG#     N = next page
P###C###N     C = close

• Reward groups fill the G slots in reading order (left to right, top to bottom), in the order they're listed in the dex type's file. Groups that don't fit go on the next page.
• G slots with no group left on the last page show the background item.
• The previous and next buttons only appear when there's a page to go to. Otherwise their slots show the background item.
• A character that isn't any element's symbol leaves the slot empty.

gui_layout should have one string per row, so 6 strings for "rows": 6, or 1 string of 5 characters for a hopper.

Elements

background_item, previous_item, next_item, close_item and player_info_item share these fields:

Field	Type	Description
symbol	string	The character that places this element in gui_layout. Only the first character is used.
item	object	The item to show. See Items for the format. If it's missing, the slot is empty. Not used by player_info_item, which always shows the viewing player's head.
item_name	string	The item's name.
item_lore	list	The item's lore, one string per line.

Group Items — group_item

Field	Type	Description
symbol	string	The character for reward group slots in gui_layout.
claimed	object	How a group the player has claimed looks.
claimable	object	How a group the player can claim looks. Clicking it claims the rewards.
locked	object	How a group the player hasn't unlocked yet looks.

Each state has these fields:

Field	Type	Description
item_name	string	The group item's name. Can use Reward Group placeholders.
show_enchantment_glint	boolean	Give the item the enchantment glint. By default, only claimable groups glint.
item	object	locked only. Replaces the group's icon while it's locked. Remove it to show the group's own icon.
item_lore	list	Not currently used. Group items show the reward group's own icon_lore from Your_Dex_Type.json in every state.

The claimed and claimable states show the reward group's own icon_item.

Changes apply with /dex reload. Reopen the GUI to see them.

See Also

• Your_Dex_Type.json: each group's icon, lore and rewards.
• Placeholders: every placeholder available in this file.