EconomyShopGUI

https://wiki.gpplugins.com/economyshopgui
Admin
EconomyShopGUI is a fully customizable GUI shop plugin for Minecraft servers that allows players to...
Tokens:110,076
Snippets:734
Trust Score:5.5
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Rotating shop configuration example in shops.yml

Source: https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml

Complete example of a rotating shop configuration in a shops.yml file. Shows the required items structure with 24 items and 6 display slots, where each item gets an approximate 4.1% display chance unless overridden. Includes various item types such as enchanted books, spawners, fireworks, and player heads.

```yaml
# Unlike regular shops, the items of a rotating shops are configured as below

# Since this shop has 24 items in total, but only 6 display slots,
# every item will have an 4.1(rounded down) percent chance to be displayed(unless specified differently)
items:
  Notch_Apple:
    material: ENCHANTED_GOLDEN_APPLE
    buy: 5000
    sell: -1
  Golden_Apple:
    material: GOLDEN_APPLE
    buy: 275.1
    sell: 68.78
  Stew_1:
    material: SUSPICIOUS_STEW
    lore:
      - '&cEvery time a surprise what the ingredients of Grandma are!'
    buy: 50
    sell: -1
    stew-effect: REGENERATION
  Stew_2:
    material: SUSPICIOUS_STEW
    lore:
      - '&cEvery time a surprise what the ingredients of Grandma are!'
    buy: 50
    sell: -1
    stew-effect: JUMP_BOOST
  Stew_3:
    material: SUSPICIOUS_STEW
    lore:
      - '&cEvery time a surprise what the ingredients of Grandma are!'
    buy: 50
    sell: -1
    stew-effect: POISON
  SILK_TOUCH:
    material: ENCHANTED_BOOK
    buy: 200
    sell: 50
    enchantments:
    - SILK_TOUCH:1
  SHARPNESS:
    material: ENCHANTED_BOOK
    buy: 972.41
    sell: 243.11
    enchantments:
    - DAMAGE_ALL:5
  EFFICIENCY:
    material: ENCHANTED_BOOK
    buy: 972.41
    sell: 243.11
    enchantments:
    - DIG_SPEED:5
  UNBREAKING:
    material: ENCHANTED_BOOK
    buy: 441
    sell: 110.25
    enchantments:
    - DURABILITY:3
  FOOD_1:
    material: COOKED_BEEF
    buy: 120
    sell: 22
    stack-size: 16
  FOOD_2:
    material: CHICKEN
    buy: 56
    sell: 9.75
    stack-size: 8
  CHEAP_STONE:
    material: STONE
    buy: 10.25
    sell: 3.5
    max-buy: -1
    max-sell: -1
    stack-size: 16
  CHEAP_SAND:
    material: SAND
    buy: 44
    sell: 13.8
    max-buy: -1
    max-sell: -1
    stack-size: 8
  SPAWNER_1:
    material: SPAWNER
    spawnertype: COW
    name: '&c[&bCow Spawner&c]'
    display-lore:
      - '&cThis spawner is 25% off, grab your change now!'
    buy: 75000
  SPAWNER_2:
    material: SPAWNER
    spawnertype: ZOMBIE
    name: '&c[&bZombie Spawner&c]'
    display-lore:
      - '&cThis spawner is 10% off, grab your change now!'
    buy: 108000
  SPAWNER_3:
    material: SPAWNER
    spawnertype: IRON_GOLEM
    name: '&c[&bIron Golem Spawner&c]'
    display-lore:
      - '&cThis spawner is 12.5% off, grab your change now!'
    buy: 875000
  BEST_INSTRUMENT:
    material: GOAT_HORN
    buy: 100
    instrument: "DREAM"
  BEST_INSTRUMENT2:
    material: GOAT_HORN
    buy: 100
    instrument: "SEEK"
  ARMOR_TRIM1:
    material: NETHERITE_CHESTPLATE
    buy: 750
    armor-trim:
      type: GOLD
      pattern: WARD
  ARMOR_TRIM2:
    material: IRON_CHESTPLATE
    buy: 250
    armor-trim:
      type: DIAMOND
      pattern: EYE
  FIREWORK_1:
    material: FIREWORK
    buy: 500
    duration: 2
    colors:
      - "cyan"
      - "purple"
    fade-colors:
      - "black"
      - "gray"
    flicker: true
    trail: true
    shape: BURST
  FIREWORK_2:
    material: FIREWORK
    buy: 500
    duration: 3
    colors:
      - "Magenta"
      - "Light_Blue"
      - "Pink"
      - "Gray"
      - "Purple"
      - "Blue"
      - "Red"
    fade-colors:
      - "black"
      - "gray"
    shape: STAR
  NOTCH_HEAD:
    material: player_head
    skullowner: notch
    buy: 500
  COLORED_LEATHER:
    material: LEATHER_CHESTPLATE
    armorcolor: "#0033FF"
    buy: 75
```

--------------------------------

### NPC-only shop command example

Source: https://wiki.gpplugins.com/economyshopgui/basics/how-to

Example of the command that the NPC will run as console to open a shop section for the player. Replace <section> with the shop section and <NPC-plugin-variable-for-the-player> with the NPC plugin's player variable.

```text
/shop <section> <NPC-plugin-variable-for-the-player>
```

--------------------------------

### name option example

Source: https://wiki.gpplugins.com/economyshopgui/basics/how-to

Example of the name option, which sets the item name and supports chat and hex colors.

```text
name:&9&lCustom coin
```

--------------------------------

### material option example

Source: https://wiki.gpplugins.com/economyshopgui/basics/how-to

Example of the material option, which sets the type of the item.

```text
material:ARROW
```

--------------------------------

### NBTData option example

Source: https://wiki.gpplugins.com/economyshopgui/basics/how-to

Example of the NBTData option, which sets the raw data of the item.

```text
NBTData:{Damage:50,HideFlags:127}
```

--------------------------------

### Configure navigation bars in config.yml

Source: https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml

Example configuration for the four navigation bars: main-menu-nav-bar, shops-nav-bar, transaction-screen-nav-bar, and sellgui-nav-bar. Shows how to set enabled, fill-item, and items with slots, actions, and paginated buttons. The sellgui-nav-bar example omits the enabled key, so it defaults to enabled.

```yaml
# The navigation bar that appears in the main menu
main-menu-nav-bar:
  enabled: true
  fill-item:
    material: GRAY_STAINED_GLASS_PANE
    name: ' '
  items:
    player_profile:
      material: player_head
      slot: 1
      skullowner: '%player_name%'
      name: '%player_name%'
    back_button:
      material: barrier
      slot: 9
      name: '%translations-cancel%'
      action: BACK

# The navigation bar that appears in every shop category
shops-nav-bar:
  enabled: true
  fill-item:
    material: GRAY_STAINED_GLASS_PANE
    name: ' '
  items:
    player_profile:
      material: player_head
      slot: 1
      skullowner: '%player_name%'
      name: '%player_name%'
    page_back_button:
      material: red_stained_glass_pane
      slot: 4
      name: '%translations-previous-page%'
      action: PAGE_BACK
      paginated:
        enabled: true
        orElse:
          material: structure_void
          name: '&cNo previous page to go to'
          action: NONE
    current_page:
      material: paper
      slot: 5
      name: '%translations-current-page%'
    page_next_button:
      material: blue_stained_glass_pane
      slot: 6
      name: '%translations-next-page%'
      action: PAGE_NEXT
      paginated:
        enabled: true
        orElse:
          material: structure_void
          name: '&cNo next page to go to'
          action: NONE
    back_button:
      material: barrier
      slot: 9
      name: '%translations-back%'
      action: BACK

# The navigation bar that appears in the buy/sell screens and the buy stacks screen
transaction-screen-nav-bar:
  fill-item:
    material: GRAY_STAINED_GLASS_PANE
    name: ' '
  items:
    player_profile:
      material: player_head
      slot: 1
      skullowner: '%player_name%'
      name: '%player_name%'
    back_button:
      material: barrier
      slot: 9
      name: '%translations-back%'
      action: BACK
      
# The navigation bar that appears in the /sellGUI screen
sellgui-nav-bar:
  fill-item:
    material: GRAY_STAINED_GLASS_PANE
    name: ' '
  items:
    info-item:
      material: NETHER_STAR
      slot: 5
      name: "&a&lSellGUI"
      lore:
        - "&6Drop items in to sell"
        - "&6upon closing, everything will be sold."
        - "&eItems that couldn't be sold"
        - "&ewill be given back to you."
```

--------------------------------

### instrument option example

Source: https://wiki.gpplugins.com/economyshopgui/basics/how-to

Example of the instrument option, which sets the goat horn sound when played.

```text
instrument:ADMIRE
```

--------------------------------

### Section config example (sections.yml)

Source: https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml

Example section configuration for a farming shop. Shows required and optional settings: enable, slot, title, sub-section, hidden, economy, fill-item, nav-bar, and item display. The file name must match the shop config filename in the shops folder.

```yaml
enable: true
slot: 4
title: " &8>>--- &a&lFarming &r&8---<< "
sub-section: false
hidden: false
economy: VAULT
fill-item:
  material: "GRAY_STAINED_GLASS_PANE"
nav-bar:
  mode: DISABLED
item:
  material: WHEAT
  name: '&aClick to enter the farming shop'
  lore: 
  - "0x00CB14Gather your farming supplies here!"
```

--------------------------------

### components option example

Source: https://wiki.gpplugins.com/economyshopgui/basics/how-to

Example of the components option, which specifies the item's raw component data for 1.20.5+. See the linked site on how to update NBTData to components.

```text
components:{"minecraft:consumable":{},"minecraft:food":{nutrition:5,saturation:7.0f}}
```

--------------------------------

### Custom currency formats configuration example

Source: https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml

Example YAML configuration for custom currency formats. Shows how to define singular/plural forms, friendly names, and formatting options for different currencies including UltraEconomy Gems, Vault, a custom item currency, and a specific currency from coins-engine.

```yaml
currency-formats:
  ultra-economy:Gems: # Gems currency from UltraEconomy
    singular: "Gem" # Displayed like: 'Buy Price: 1 Gem'
    plural: "Gems" # Displayed like: 'Buy Price: 5 Gems'
    friendly: "Gems" # Displayed like: 'You do not have enough Gems'
  vault: # Vault economy provider
    singular: "%currency-symbol%" # Displayed like: 'Buy Price: $1'
    plural: "%currency-symbol%" # Displayed like: 'Buy Price: $5'
    friendly: "money" # Displayed like: 'You do not have enough money'
  item:Bullets: # Custom item economy using ID 'Bullets'
    singular: "Bullet" # Displayed like: 'Buy Price: 1 Bullet'
    plural: "Bullets" # Displayed like: 'Buy Price: 5 Bullets'
    friendly: "Bullets" # Displayed like: 'You do not have enough Bullets'
  coins-engine:Cash2: # Cash2 currency from coins-engine
    format: "#,##0.#" # Displays the currency with only 1 decimal point(overrides the default)
    locale: "fr-FR"   # Sets the locale this currency is formatted with
    abbreviations:
      enabled: true# Overrides the default setting for all currency's
      formats:
      - 'KK'
      - 'MM'
      - 'BB'
```

--------------------------------

### lore option example

Source: https://wiki.gpplugins.com/economyshopgui/basics/how-to

Example of the lore option, which sets the item lore and supports chat and hex colors. Multiple lines are split using \n.

```text
lore:This is a custom message\n&cYou can use &4&lcustom &ccolors aswell!
```

--------------------------------

### potiontypes option example

Source: https://wiki.gpplugins.com/economyshopgui/basics/how-to

Example of the potiontypes option, which sets the potion effects of the item. Multiple values are split using commas.

```text
potiontypes:FIRE_RESISTANCE,STRONG_HARMING,LONG_INVISIBILITY
```

--------------------------------

### Call EconomyShopGUIHook method

Source: https://wiki.gpplugins.com/economyshopgui/api

Basic example of calling a method from the EconomyShopGUIHook class.

```java
EconomyShopGUIHook.someMethod();
```

--------------------------------

### skull-texture option example

Source: https://wiki.gpplugins.com/economyshopgui/basics/how-to

Example of the skull-texture option, which sets the skull texture. Valid values can be grabbed from the linked site.

```text
skull-texture:eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA 6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvM2ZkYWI0MDQzNGVkNWQwMWY1OGM0NWNhMGM5ZmFkYTQ2NjJlMTc3MmZmNDNlMjk3NDk3OTQ0MGE1Y2ZlMTVjOSJ9fX0=
```

--------------------------------

### Shops file example with Armor shop and item configuration

Source: https://wiki.gpplugins.com/economyshopgui/file-configuration/about-yaml-yml-files

Example of a shops.yml file showing the YAML structure for a shop section named 'Armor'. It demonstrates indentation levels, item index '1', material, buy/sell prices, lore list with escaped quotes, and enchantments list. Note that negative buy/sell values disable buying/selling, and Minecraft chat color codes are supported in lore.

```yaml
#Shops file example:
#The first level in a YAML file will have ZERO spaces before it
####The shop section CANNOT HAVE SPACES in it, but can use _ underscores.
####The shop section MUST MATCH EXACTLY with what you have defined in the sections.yml for it.
Armor: #nothing follows the : after this field. It is a header for subsequent settings/items
  #The next level has TWO SPACES before it. These lines are sub-parts of the defined value above (Armor)
  ####(shops.yml specifc) Note: ESGUI does not require the following value to be numerical. you can use words and most characters. 
  ####This is the <index/item> that will be used with the /shopedit command. 
  ####It is reccomended to use numbers in 1.12 and lower, 
  ####1.13+ has command-tab-complete that can assist in filling out the command, and naming your items here can be helpfull in this case.

  '1': #again, nothing follows the : becasue it is the defieing valuse for the parts that follow...
  #
    #options are another level below the index/item, and have an additional two spaces fro mthe above line. 
    #This line has FOUR SPACES before it.
    material: GRASS_BLOCK 
      #There must be a space immediately after the : , Then a SINGLE SPACE, followed by the defined value.
      #Double quotes around the value are only required for values with special characters and spaces
    #still at FOUR SPACES as these options are more values for item '1'      
    buy: 20
    #### setting the value to a NEGATIVE number in either buy or sell will disable that option 'item cannot be bought/sold'
    sell: -1
    lore: #List lines start like a new sub-level, but use a - to define the start of each line in the list
    #in this case we are expecting lines of text, so we MUST enclose them with double-quotes ""
    #if you want to use double-quotes IN your line of text, you MUST 'Escape' it by printing it TWICE. (must still start and end with double-quotes)
    ####Minecraft chat color codes are supported
    - "example lore"
    - "&c""Second"" line of lore"
    enchantments:
    #another list-foramt is an array. mainly used for enchantments in ESGUI. 
    #it uses the Enchantment_name immediately followed by a : and again immediately followed by the enchantment level
    - EFFICIENCY:5 
    - FORTUNE:3
```

--------------------------------

### Sections folder YAML indentation example

Source: https://wiki.gpplugins.com/economyshopgui/file-configuration/about-yaml-yml-files

Example of a sections file with 2 spaces before 'material', 'mode', and 'name' sub-settings. Use this as a reference for the required indentation in section YML files.

```yaml
enable: true
slot: 19
title: ''
hidden: false
sub-section: false
display-item: false
fill-item:
  material: AIR
nav-bar:
  mode: INHERIT
item:
  material: GRASS_BLOCK
  displayname: '&2&lBlocks'
  name: '&2&lBlocks'
```

--------------------------------

### Use EconomyProvider for balance, deposit, withdraw

Source: https://wiki.gpplugins.com/economyshopgui/api

Basic operations on an EconomyProvider: get balance, deposit, and withdraw amounts.

```java
Double balance = provider.getBalance(player);
```

```java
provider.depositBalance(player, amount);
```

```java
provider.withdrawBalance(player, amount);
```

--------------------------------

### Configure buy/sell/click commands with placeholders and delays

Source: https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml

Example shop item configuration showing click-commands, buy-commands, and sell-commands with placeholders, p:/o: prefixes, and delayed command syntax. Note that purchasing multiple items does not run commands multiple times; use %quantity% instead. The o: prefix grants temp OP and is exploitable, so prefer temp permissions via a plugin like LuckPerms.

```yaml
pages:
  pages1:
    items:
      1:
        material: "GOLD_INGOT"
        displayname: "&8&lGet rich or unlucky."
        buy: 1000000
        sell: 250000
        giveItem: true
        click-commands:
        - "40::o:/playsound entity.ender_dragon.growl ambient" # Plays the sound effect 2 seconds after clicking the shop item
        buy-commands:
        - "/minecraft:give %player% diamond 2"
        - "/minecraft:give %player% emerald %quantity%" #This command gives out emeralds based on the amount of times the shop item was purchased
        - "p: repair hand" # This command is executed as the player
        - "o: i netherite_ingot 5" # This command is executed as the player having temp OP
        requireItem: true
        sell-commands:
        - "20::/minecraft:give %player% MILK_BUCKET 1" # Will be delayed by 1 second
        - "eco reset %player%" # This command will get executed as the console
        - "effect give %player% minecraft:nausea 255 255"
```

--------------------------------

### Example section config file with all options

Source: https://wiki.gpplugins.com/economyshopgui/file-configuration/sections.yml

Reference section configuration file for /sections/<shopName>.yml. Shows required options like slot, and optional settings such as title, hidden, sub-section, display-item, hide-if-no-perms, economy, and close-menu. The file name must match the corresponding shop file in /shops/.

```yaml
# This is an example section file which is only a reference for how section configs should be created in /sections/<shopName>.yml folder

# The file name defines the shop internal name and needs to match the filename for the section inside the shops folder
# Example:
# /sections/Food.yml -> /shops/Food.yml
# /sections/Workstations.yml -> /shops/Workstations.yml
#
# If this does not match, an example section will be created with name '<shopName>.yml', so make sure it matches!

# Defines whether this section should be loaded at all
enable: true

# The slot of the section item inside the main shop screen
slot: 5
# This is a required option

# The title of the shop, different from the shop name
title: "&c&lExample_Shop"
# Defaults to the item name if empty

# Whether this shop section can be seen and accessed via the main shop
# If a section is hidden, it will be only accessible through the direct shop command (/shop <shopName>)
hidden: false

# Whether this shop is a subsection,
# subsections will be hidden from the main menu and cannot be opened via commands
sub-section: false

# Makes this section a simple display item to decorate the main shop GUI
# Display items won't have a section linked and nothing will happen when a player clicks it inside the main shop GUI,
# neither will this section be accessible via /shop <shopName>
display-item: true

# Hides this shop's item from the main menu if the player
# does not have permissions to this shop
hide-if-no-perms: true

# The economy used within this section, this is the same format as the config.yml uses
# See a list of all available economy types here: https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml#economy-provider
economy: "ITEM:material:EMERALD name:&a&lGems"

# If click commands are used within this section, should we close the shop after the click commands have been executed?
# If disabled with click commands, the shop will open like normal while click commands are being executed in the background.
close-menu: false
```

--------------------------------

### Enable custom grid forms for Bedrock

Source: https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml

When enabled, assumes the JsonShopForms pack is installed and setup using Geyser, and uses a custom form to recreate a Java-like GUI while keeping Java-like features for Java players.

```yaml
  use-grid-forms: false
```

--------------------------------

### CustomModelData option example

Source: https://wiki.gpplugins.com/economyshopgui/basics/how-to

Example of the CustomModelData option, which sets the CustomModelData for the item.

```text
CustomModelData:1003
```

--------------------------------

### Basic shop pages configuration

Source: https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml

Example shop configuration with two pages. Each page defines gui-rows, a title, and items with material, buy, and sell prices. Leaving buy or sell unspecified makes the item unbuyable or unsellable.

```yaml
pages:
  page1: # The page index
    gui-rows: 6 # Amount in rows (1 row is 9 slots)
    title: "   &8<=== &aExample page &c1 &8===>   "
    items:
      1: # The item index (can be anything, not just numbers)
        material: milk_bucket
        buy: 20
        sell: 2
  page2: # The page index
    gui-rows: 2 # Amount in rows (1 row is 9 slots)
    title: "   &8<=== &aExample page &c2 &8===>   " # Per page title
    items:
      1: # The item index (can be anything, not just numbers)
        material: gold_ingot
        buy: 9000
        sell: 2800
```

--------------------------------

### ignored-tags option example

Source: https://wiki.gpplugins.com/economyshopgui/basics/how-to

Example of the ignored-tags option, which ignores NBT/component data on the item.

```text
ignored-tags:enchantments,trim,food
```

--------------------------------

### Add EconomyShopGUI-API dependency (Maven/Gradle)

Source: https://wiki.gpplugins.com/economyshopgui/api/api-usage

Add the JitPack repository and the EconomyShopGUI-API dependency to your build file. Use the Maven snippet in pom.xml or the Gradle snippet in build.gradle. Replace VERSION with the actual version. Also add `softdepend: [EconomyShopGUI, EconomyShopGUI-Premium]` to plugin.yml.

```xml
<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>
<dependencies>
    <dependency>
        <groupId>com.github.Gypopo</groupId>
        <artifactId>EconomyShopGUI-API</artifactId>
        <version>VERSION</version>
        <scope>provided</scope>
    </dependency>
</dependencies>
```

```groovy
allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}
dependencies {
		implementation 'com.github.Gypopo:EconomyShopGUI-API:VERSION'
}
```

--------------------------------

### skullowner option example

Source: https://wiki.gpplugins.com/economyshopgui/basics/how-to

Example of the skullowner option, which sets the skull owner of the item.

```text
skullowner:Notch
```

--------------------------------

### Dynamic pricing per item (enabled, max-stock, price-restoration)

Source: https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml

Configures dynamic pricing for a single item. `enabled: false` disables dynamic pricing for this item only; global dynamic pricing must be enabled for this to work. `max-stock` overrides the global DP max stock setting for this item, with lower values causing faster price changes. `price-restoration.target-value` sets the target dynamic price percent; for example, with buy scaling 25% and target -50% on a 1000$ buy price, the price restores to 875$.

```yaml
pages:
  pages1:
    items:
      Item14:
        material: GOLD_NUGGET
        name: '&6&lCoin'
        lore:
        - '&cUsed to purchase ingame ranks'
        buy: 40
        sell: 20
        dynamic-pricing:
          enabled: false
          max-stock: 1000
          price-restoration:
            target-value: "-50%"
```

--------------------------------

### Get player balance

Source: https://wiki.gpplugins.com/economyshopgui/api/api-usage

Get the player's balance using the obtained EconomyProvider.

```java
Double balance = provider.getBalance(player);
```

--------------------------------

### Item with displayname and name

Source: https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml

Example item configuration showing the difference between displayname (shown in shop) and name (on the bought item). The name option also sets the display name when displayname is not specified.

```yaml
#Example item with a name that is only shown in the shop, AND a name that is on the item bought.
pages:
  pages1:
    items:
      1:
        material: milk_bucket
        buy: 20
        sell: 2
        displayname: "&f&lGot Milk?" #this is what is shown in the shop.
        name: "&bWe got &f&lMilk!" #this is the name that will be on the item when purchased/bought.
```

--------------------------------

### id option example

Source: https://wiki.gpplugins.com/economyshopgui/basics/how-to

Example of the id option, used to set the currency's ID for singular and plural forms.

```text
id:Bullets
```

--------------------------------

### stew-effect option example

Source: https://wiki.gpplugins.com/economyshopgui/basics/how-to

Example of the stew-effect option, which sets the stew effect for SUSPICIOUS_STEW. Multiple values are split using commas.

```text
stew-effect:WITHER,POISON
```

--------------------------------

### Shop section config structure with pages and items

Source: https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml

Shows the YAML structure for a shop section config, including the pages, items, and item keys. The example defines a page with GUI rows, a title, a bedrock title, and an item with material, name, buy/sell prices, and lore.

```yaml
###### code formatting reference names: ######
pages:
  <page>:
    items:
      <itemIndex>:
        <key>: <value> #Single value key
        <key>: #List-format must support multiple values. (lore, enchants, etc..)
        - <value1>
        - <value2>
###### example: ######
pages:
  page1:
    gui-rows: 6
    title: "&dCustom title for this page"
    bedrock-title: "&bOnly bedrock players can see this"
    items:
      item1:
        material: PAPER
        name: "Egyptian Papyrus"
        buy: 6
        sell: 2
        lore:
        - "Papyrus from ancinet Egypt"
```

--------------------------------

### enchantments option example

Source: https://wiki.gpplugins.com/economyshopgui/basics/how-to

Example of the enchantments option, which sets the item's enchantments. Multiple values are split using commas.

```text
enchantments:SHARPNESS:5,EFFICIENCY:5,MENDING,ecoenchants:BLAST_MINING:3,advancedenchants:STRIKE:2,excelentenchants:BLAST_MINING:3
```

--------------------------------

### Configure item actions (PAGE_BACK, PAGE_NEXT)

Source: https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml

Defines shop items with actions: CLOSE, BACK, PAGE_BACK, PAGE_NEXT, or SEARCH (Premium only). When an action is set, the item acts as a display item; most item options no longer work, but requirements and/or click-commands can still be added.

```yaml
pages:
  page3:
    items:
      page_back_button:
        material: COMPASS
        action: PAGE_BACK
        name: '&6Click me to go to the %math_%page%-1% page'
        slot: 1
      fill:
        material: AIR
        slot: 2-8
      next_page_button:
        slot: 9
        material: COMPASS
        action: PAGE_NEXT
        name: '&6Click me to go to the %math_%page%+1% page'
        requirements:
        - 'QUEST::miner_luck' # Requires players to complete the QUEST 'miner_luck' 
                              # to view the next page of this shop
```

--------------------------------

### Shop item with multiple requirements

Source: https://wiki.gpplugins.com/economyshopgui/file-configuration/shops.yml

Example shop item configuration that uses multiple requirement types. The player must meet all requirements before buying or selling the item. The requirements list includes quest, time, level, region, item, playtime, permission, and placeholder checks.

```yaml
pages:
  pages1:
    items:
      9:
        material: SPAWNER
        spawner-type: BLAZE
        displaylore:
        - "&aA advanced spawner only experienced players can use"
        buy: 1000000
        sell: 250000
        slot: 13
        requirements:
        - "QUEST::firstAdventurer" # Requires the player to complete the 'firstAdventurer' quest
        - "TIME::22:00-06:00" # Requires the world time to be between 10PM and 6AM
        - "LEVEL::35" # Requires a minimum level of 35
        - "REGION::warp_shop" # Requires the player to be insidee the shop warp
        - "ITEM::material:tripwire_hook components:{'minecraft:custom_data':{SecretKey:1}}" # Requires the Secret Key to buy/sell this shop item
        - "PLAYTIME::15m" # Requires a minimum playtime of 15 minutes
        - 'PERMISSION::!essentials.fly' # Checks if the player doesn't already have the 'essentials.fly' permission node
        - 'PLACEHOLDER::%player_biome%==SWAMP' # Requires the player to be inside a SWAMP biome
        - 'PLACEHOLDER::%votingplugin_total_daily%!=0' # Requires the player to have voted atleast once
```

--------------------------------

### EconomyProvider.getBalance(Player)

Source: https://wiki.gpplugins.com/economyshopgui/api

Gets the balance of a player.

```APIDOC
## [GET] EconomyProvider.getBalance(Player)

### Description
Gets the balance of a player.

### Method
GET

### Endpoint
EconomyProvider.getBalance(Player)

### Parameters
#### Path Parameters
- **player** (Player) - Required - The player.

### Response
#### Success Response (200)
- **Double** (Double) - The player's balance.

#### Response Example
```
100.0
```
```

--------------------------------

### Get or load player price modifiers with EconomyShopGUIHook

Source: https://wiki.gpplugins.com/economyshopgui/api/api-usage

Retrieves all price modifiers for a player. The first gets modifiers for a loaded/online player; the second loads modifiers from the database for an offline player. Both return null if the player isn't loaded or has no modifiers.

```java
PlayerPriceModifier modifiers = EconomyShopGUIHook.getPlayerPriceModifiers(player.getUniqueID());
```

```java
PlayerPriceModifier modifiers = EconomyShopGUIHook.loadPlayerPriceModifiers(player.getUniqueID());
```

--------------------------------

### Configure command aliases for shop, sellall, and sellgui

Source: https://wiki.gpplugins.com/economyshopgui/file-configuration/config.yml

Define custom command names or aliases for the shop, sellall, and sellgui commands. Do not include a leading slash, as it would result in double slashes.

```yaml
# Set different aliases for the main shop command, defaults to /shop if empty
shop-commands:
  - "shop"
# - "market"

# Set different aliases for the sellall command, defaults to /sellall if empty
sellall-commands:
  - "sellall"

# Set different aliases for the sellgui command, defaults to /sellgui if empty
sellgui-commands:
  - "sellgui"
```

--------------------------------

### Give a shop stand item

Source: https://wiki.gpplugins.com/economyshopgui/basics/how-to

Command to give yourself a shop stand to place down. Replace <type>, <section>, and <itemIndex> with appropriate values.

```text
/eshop shopstands give <type> <section> <itemIndex>
```
Tokens:
Raw