Configuration

A more indept explanation of the config options from PlayerMarketGUI

Economy provider

This option allows you to set the economy system used by the plugin, currently supported plugins:

• VAULT = Vault is the default economy provider. Vault needs a economy plugin such as Essentials or CMI(Using Vault injector) to work.

• COINS_ENGINE = CoinsEngine (Formally known as GamePoints) is a multi currency economy provider which support MySQL

• PLAYER_POINTS = PlayerPoints is a advanced economy provider which supports MySQL but does not support decimal prices such as other economy providers.

economy-provider: VAULT

To use a specific currency from a multi currency plugin(eg. COINS_ENGINE) you need to specify it like COINS_ENGINE:<currency>

Features

Auction House

The Auction House is the marketplace where players can list items for sale. Items can either be listed as buy now listings or bidding auctions, depending on whether the bidding feature is enabled inside the config.yml

auction-house:
  # Enable or disable this feature
  enabled: true

The option to allow partial purchases can be toggled to allow players purchasing partial auction house listings, meaning players can purchase a specific quantity of items instead of the listed amount. Where doing a partial purchase would leave the remaining items listed on sale in the auction house till it is bought or expired.

  partial-purchases: false

Player Shops

Player Shops allow players to create their own virtual storefronts. Each shop can contain multiple listings, whereas players can customize shop details like the name, description and even a custom icon to make it stand out from other player shops on the server.

player-shops:
  # Enable or disable this feature
  enabled: true

Toggling this option on/off allows players to change the item names/lore of items they put for sale in their player shops

  allowChangingNameLore: true

The restock settings allow configuring limits for restocking player shop GUI listings on your server, where if enabled, players can keep restocking the item until stock runs out eventually or it expires and gets removed automatically. Stock for player GUI listings is stored virtually in 'Vaults' and is accessed only when someone purchases from it.

  restock:
    # Enable or disable this feature
    enabled: false

This setting sets a maximum amount of items stacks that can be put in the 'Vault'

    max-stacks: 9

Note that this setting counts stacks, instead of items, for example:

• STONE_BRICKS: 64 * 9 = 576

• ENDER_PEARL = 16 * 9 = 144

• DIAMOND_SWORD = 1 * 9 = 9

Chest Shops

Because not everyone might like player shops being run completely GUI based, thats why Chest Shops still give the physical version of player shops while allowing unlimited stock by supporting hoppers that can feed items into the chests.

chest-shops:
  # Enable or disable this feature
  enabled: true

Disabled worlds prevent players from creating chest shops in specific worlds

disabled-worlds:
  - 'SpawnWorld'
  - 'world_nether'
  - 'world_the_end'

The hologram settings allow customization of the holograms floating above chest shops, enabling or disabling it will toggle it on/off for every chest shop on the server

  hologram:
    # Enable/disable the hologram above chest shops
    enabled: true
    # The offset of the hologram above the chest shop
    offsetY: 1.4

Configure the text of the holograms above chest shops Possible placeholders are: %item%, %stock%, %price%, %owner%, %x%, %y%, %z%, %world%

    lines:
      - "&aChest Shop"
      - "&f%item% &7x%stock%"
      - "&e%price% &7each"

Shop Links *Premium feature

Shop links are a solution which allows stock for shop items to be stored physically instead of virtually inside the player GUI shop listings 'Vault'. Shop links allow a chest shop to be linked with a player GUI shop, effectively making it accessible thru the GUI while stock is still being stored inside the chest

    shop-links:
      # Enable or disable new shop links from being created
      enabled: true

Disabling this option won't allow GUI purchases from this chest shop and encourages players to visit the shop to

      allow-gui-purchases: true

Disabling this option would only allow GUI purchases from a linked chest shop if it is inside a loaded chunk, this can either be a player loading a chunk or a external source like Chunk Loaders. Note that you may experience performance issues when leaving this option enabled, as the server will try to load chunks of chest shops that are unloaded when a purchase thru the GUI is made.

      allow-gui-purchases-if-unloaded: false

Bidding

Bidding introduces an auction style system where items are sold to the highest bidder when the listing duration expires. Players can place bids on auction listings, where each bid increases the price. Additionally a buyout price can be set to expire the listing when the target price has been hit, where the item is sold to the player doing the final bid.

bidding:
  # Enable/disable this feature
  enabled: true

Offers *Premium feature

The Offers feature allows buyers to propose alternative prices for listings, allowing the seller of the item to either confirm the offered price or deny the offer completely.

When a seller cancels a offer or the listing from that offer expires, the money taken initially will return to the buyer's inbox.

offers:
  # Enable/disable this feature
  enabled: true

Delivery *Premium feature

The Delivery feature gives players the option to request items for a set price, where players can browse the delivery board and fulfill delivery's from other players where the price for each delivered item is payed out to the player that delivers it.

delivery:
  # Enable/disable this feature
  enabled: true

Price Suggestions *Premium feature

Price Suggestions help players in setting competitive prices when listing items in the auction house or player shops. The price is suggested as the Market Average price based on recent transactions for the sold item's type.

price-suggestions:
  # Enable/disable the price suggestions feature
  enabled: true

Storage

All data market related is stored within the database, while still ensuring minimal server performance by effectively utilizing advanced async/sync task scheduling

SQLite

SQLite stores all data locally inside a database file

storage:
  # The type of storage to use, can be sqlite or mysql
  type: sqlite

MySQL *Premium feature

MySQL uses a remote database allowing it to sync data across multiple instances. Setting the storage type to MySQL requires these settings to be configured to use our database.

  mysql:
    # The name of the database to connect to
    database: database
    # The host of the database connection
    host: 127.0.0.1
    # The port of the database connection
    port: 3306
    # The username for the database connection
    username: root
    # The password for the database user
    password: ""
    # Additional parameters for the database connection
    params: useSSL=false&autoReconnect=true
    # DO NOT CHANGE THIS UNLESS YOU KNOW WHAT YOU ARE DOING, THIS CAN CAUSE DATA LOSS IF CHANGED AFTER THE PLUGIN HAS BEEN USED
    # Only change this prefix if you want to run multiple instances of the plugin on the same database
    table-prefix: "pmgui_"

Commands

The four main commands of the plugin have its own config settings to allow customizing the command aliases an even register it as root Root commands are basically similar to the sub commands, but instead accessible without the plugin prefix to make command execution more familiar for your players

commands:

  # The command to open the auction house
  auction-house:
    # Disabling this will prevent the command(and any aliases) from being registered as a root command
    # and can only be accessed as a subcommand (/pm auctionhouse)
    registerCommandAsRoot: true
    # Set the command aliases for the subcommand(s) and/or root command(s) depending on the setting above
    aliases:
      - auctionhouse
      - auction
      - ah

  # The command to list an item on the auction house
  list-item:
    # Disabling this will prevent the command(and any aliases) from being registered as a root command
    # and can only be accessed as a subcommand (/pm listitem)
    registerCommandAsRoot: true
    # Set the command aliases for the subcommand(s) and/or root command(s) depending on the setting above
    aliases:
      - listitem
      - list

  # The command to open the player shops menu
  player-shops:
    # Disabling this will prevent the command(and any aliases) from being registered as a root command
    # and can only be accessed as a subcommand (/pm playershops)
    registerCommandAsRoot: true
    # Set the command aliases for the subcommand(s) and/or root command(s) depending on the setting above
    aliases:
      - playershops
      - pshops
      #- market

  # The command to open the inbox menu
  inbox:
    # Disabling this will prevent the command(and any aliases) from being registered as a root command
    # and can only be accessed as a subcommand (/pm inbox)
    registerCommandAsRoot: true
    # Set the command aliases for the subcommand(s) and/or root command(s) depending on the setting above
    aliases:
      - inbox