Item Configuration

This page explains how the configuration system works and how you can edit any item including game items.

Important:
If you use color codes in a string or configure an item: with a : you have to use single quotes: '&eYour string'. If you get a YAML error when you use /pg reload do NOT press yes when notepad++ asks if you want to reload. This will reset the whole configuration and you will lose everything! Press no, take a backup, fix the error, and try again.

Required setting:

Only one setting is required to create a valid item. Pick one of the below: (Cannot contain both.)

Option	Type	Examples	Description
item:	String or Integer	Stone Stone:1 1:1	Items are case-insensitive. An item is created from a Material ID or Material Name and optionally a Data value. Material and Data are separated by a colon.
head:	Playername or URL	Benz56 URL Example	Use either a playername or a head URL.

Optional settings:

All of the settings below affect the item visually.

Setting	Type	Default	Example	Description
name:	String	none	name: &aGrass	Set the name of the item/head.
lore:	List	none	lore: - '&aHi' - '&ethere! :)'	Set the lore of the item/head.
glow:	Boolean	false	glow: true	Add enchantment glow to any item.
itemFlags:	List	none	- HIDE_ATTRIBUTES	Add itemFlags to your items to hide things like how much damage a sword deals or how much protection a piece of armor provides.
customModelData:	Integer	none	- 1234567	Set the CustomModelData for the item. This works in 1.14 and up.

Other configuration settings below:

Main Selector Options:

Uses general item configuration.

• header: Set the main gui header title.
• border: Configure the border of the selector.
  • enabled: Enable/Disable (true/false) the border.
• Info: Selector info item.
  • enabled: Enable/Disable (true/false) the border.

Game Item Settings:

Each game can be configured in their designated file in the GameConfigurations folder.

• Enabled: Enable/Disable (true/false) the game. Hides the game from the selector & /pg list.
  • This is bypassed with either OP or the pocketgames.bypass.enabled permission.
• GameHeader: Set the gui header of the game. Changing a games header changes the play command along with it!
  • Play command implementation: /pg play 'header'.

No Permission Item:

This item will show whenever a player clicks an item which function they do not have permission for.

• ShowTicks: Set a number of ticks the item will be shown for (20 ticks = 1 second).
   

Hotbar Settings:

Items can be disabled by setting enabled: to false.

• SoundToggle: It is possible to configure both states (on/off) of the sound item.
• CustomMenu: If true the Main Menu button will execute a command instead of opening the Main Menu.
• Command: Will execute this command if the prior is set to true. Valid placeholder: %player%. Make sure the command does not open an inventory that saves the inventory.
   

Countdown Settings:

Uses general item configuration.

• Enabled: Option to enable or completely disable the countdown.
• Numbers: Set the appearance of the numbers 3, 2, and 1.
• Underline:
  • Enabled: Enable/Disable the underline. If disabled the numbers will move one row down.
• Filler:
  • Enabled: Enable/Disable the filler item. Fills the remaining space with the configured item.
     

Game Over Settings:

Uses general item configuration.

• border: Configure the border of the game over gui.
• Result:
  • Lore1: Displays if a player did not enter the high score.
  • Lore2: Displays if a player did enter the high score.
    %time% and %points% are valid placeholders in the lores.
     

Highscore Settings:

Uses general item configuration.

• border: Configure the border of the high score gui.
• top: Configure the name and lore of the top five heads. Placeholders:
  • %position%: Can be used in default name and default lore.
  • %player%: Can be used in 1, 2, 3, 4, and 5 names and lore.
  • %score%: Can be used in 1, 2, 3, 4, and 5 names and lore.