UltimateShop Wiki
  • 🎉Welcome
  • 🌏Other Language Wiki
  • 📦Info
    • ✅Requirements
    • ⚙️Install
    • 🔗Compatibility
    • 🛠️Configuration files
    • ⌨️Commands
    • 📊Data
    • 🚀Performance
    • ❓FAQ
    • 🆚Compare
  • 📋Format
    • 🛒Info of ItemFormat™
    • 📝ItemFormat™
    • 💹EconomyFormat™
    • 🖼️Display Item Format
    • 🎬Action Format
    • ⚖️Condition Format
    • ➗Math Calculate Format
  • 🔌Menus
    • 🔲General Menus
    • 🔽Buy More Menus
    • 🛏️Bedrock Menus - Premium
    • 🥉Display Item Add Lore
  • 🛍️Shops
    • 📂Shops
    • 🛒Products
    • 💰Products Config: Single Thing
    • ♻️Product Config: Buy/Sell Times Reset
    • 📚Common Examples
    • 🌱Example: Stock (like in life)
    • 📅Example: Daily Shops
    • 🏆Example: Daily Rewards
  • 📍Placeholders
    • 🔧Built-in Placeholder
    • 🔀Random Placeholder - Premium
    • ⛓️Conditional Placeholder - Premium
    • 🔖Example: Discount
  • 💰Dynamic Prices
    • 🔄Dynamic Price
    • 🔴Dynamic Price Status - Premium
  • ✨Features
    • 🎨Color Code
    • 💴Easy Prices
    • 🪄Sell Stick - Premium
    • 💾Saved Item
    • 🌍Localized Item Name - Premium
    • 🌐Multi Server Sync - Premium
    • 🔢Number Format
    • ✏️In-game Editor - Premium
    • 🎮Custom Click Event - Premium
    • 🔍Custom Item Match Method
    • 🔑Give Item Method
    • 💳Log Transaction - Premium
  • 💻Develop
    • Develop Guide
    • Events
    • Hook into UltimateShop
    • Can't do things
Powered by GitBook
On this page
  • Items ID / Product ID
  • General Options
  • Single Thing Options
  • Buy/Sell Times Reset Options
  • Dynamic Value
  • Sub Buttons - Premium
  1. 🛍️Shops

🛒Products

Here is an example of 2 product configs:

items:
  A:
    price-mode: CLASSIC_ALL
    product-mode: CLASSIC_ALL
    products:
      1:
        material: STRING
        amount: 1
        give-actions:
          1:
            type: message
            message: 'You get a string!'
    buy-prices:
      1:
        match-placeholder: '%player_health%'
        amount: '1.65'
        placeholder: '{amount}$'
        start-apply: 0
    sell-prices:
      1:
        match-placeholder: '%player_health%'
        amount: '1.65'
        placeholder: '{amount}$'
        start-apply: 0
        give-actions:
          1:
            type: console_command
            command: 'eco give {player} {amount}'
  B:
    price-mode: CLASSIC_ALL
    product-mode: CLASSIC_ALL
    products:
      1:
        material: FEATHER
        amount: 1
    buy-prices:
      1:
        economy-plugin: Vault
        amount: '0.55'
        placeholder: '{amount}$'
        start-apply: 0
    sell-prices:
      1:
        economy-plugin: Vault
        amount: '0.52'
        placeholder: '{amount}$'
        start-apply: 0

Items ID / Product ID

Product ID must be a single char, because we need use them in shop menu layout option.

General Options

    • display-item.modify-lore: Whether we will modify display item lore. Optional (default to true)

  • display-name: Set product display name in {product} placeholder and buy more menu display item. Optional.

  • buy-more: Set whether this product can open buy more menu, you must delete shop's buy-more option to make this option has effect! Optional.

  • buy-more-menu: Set up separate buy more menu settings for the product. Optional. Require 2.2.10+ version.

  • price-mode: Support ANY, ALL, CLASSIC_ANY, CLASSIC_ALL. Required.

  • product-mode: Same as above. Required if you have products section.

Mode
ANY
ALL
CLASSIC_ANY
CLASSIC_ALL

Product Give

Give random products that meet conditions.

Give all products.

Same as ANY.

Same as ALL.

Product /Price Take

First product/price that we found player meet condition and have enough amount.

Players must have all products/prices that meet conditions to sell.

Same as ANY.

Same as ALL.

Price Give (means sell)

First prices meet the condition requirements.

All prices will be given.

Same as ANY.

Same as ALL.

Price Support

Support dynamic price & apply option.

Same as ALL.

Price must be same at everytime.

Same as CLASSIC_ALL.

Server Performances

Maybe high when you have much buy/sell requests.

Same as ALL.

Low, just like other shop plugins doing!

Same as CLASSIC_ANY.

  • buy-limits: Set the maximum times of buy/sell times. Optional. If not set, product can be purchased with unlimited times.

    • buy-limits.global: Global limit. Optional.

    • buy-limits.default: If player don't meet any condition set below, they will use this limit. Required if you have set buy-limits.

buy-limits:
  default: 10
  vip: 20
buy-limits-conditions:
  vip: 
    1:
      type: permission
      permission: 'test.permission'
  • sell-limits: Same as buy-limits, but use for sell.

Single Thing Options

This section of the configuration includes the following options:

  • buy-prices

  • sell-prices

  • products

Buy/Sell Times Reset Options

This section of the configuration includes the following options:

  • buy-times-reset-mode

  • buy-times-reset-time

  • buy-times-reset-time-format

  • sell-times-reset-mode

  • sell-times-reset-time

  • sell-times-reset-time-format

Dynamic Value

  • {buy-times-player}

  • {buy-times-server}

  • {sell-times-player}

  • {sell-times-server}

  • {last-buy-player}

  • {last-buy-server}

  • {last-sell-player}

  • {last-sell-server}

Also in buy-prices and sell-prices section, you can set new 2 options:

  • max-amount: Price max amount, useful for dynamic prices. Optional.

  • min-amount: Price min amount, useful for dynamic prices. Optional.

Please carefully note that if you want to use our PlaceholderAPI extansion's placeholder, you have to use our new format, for example:

    buy-prices:
      1:
        economy-plugin: Vault
        amount: '15 - {sell-times-player} * 0.1 + %ultimateshop_farming_B_sell-times-player% * 0.1'
        # We use the new format without { and } symbol.
        placeholder: '{amount}$'
        start-apply: 0

Additionally, you need to set menu.shop.click-update to true if the related to product is also in the menu you opened. Otherwise this price won't auto update after you sell B product.

Sub Buttons - Premium

Sometimes, you want to display same product in different menus, or you want to make 2 or more buttons for same product. Well, as-sub-button option can help you. Just set another product ID here, then this button will also be considered as the product you set here.

  • display-item: Supports set different display item for sub buttons.

  • as-sub-button: Type Product ID or ShopID;;ProductID here.

Previous📂ShopsNext💰Products Config: Single Thing

Last updated 3 months ago

display-item: Product display item in shop menu, it can be different from the real item player will obtain after purchase. For virtual items, you must set display-item here, otherwise they can not be displayed in GUI. For real items, you must enable auto-set-first-product option under display-item section to let you remove this section, after enable, if display-item is not set, the first product real items will be used as display item. This section use . Optional (if not set, will use first products)

add-lore: Set special for this product, if not set, we will use default value set in config.yml. Optional.

bedrock: View .

buy-actions: The action will run after buy this product, use t here. Optional.

sell-actions: The action will run after sell this product, use t here. Optional.

fail-actions: The action will run if we fail to buy or sell this product, use t here. Optional. In example above we put this on general-configs and set it as a fail sound.

buy-conditions: The condition player need to meet to buy this product, use here. Optional.

sell-conditions: The condition player need to meet to sell this product, use here. Optional.

buy-limits.<Condition ID>: Players who meet this condition will use this limit. Condition format can be found at . For example:

The introduction of these options is on a separate page, please to view.

The introduction of these options is on a separate page, please to view.

You can set placeholders and in buy-prices, sell-prices section's amount option and buy-limits, sell-limits section's value in shop configs.

Available built-in placeholder, for more info about them, please view page.

The example of Sub Buttons can be found at page, please check out the C section under items in the head example.

Item format
display item add lore
this page
Action Forma
Action Forma
Action Forma
Condition Format
Condition Format
Conditions
click here
click here
Math Calculate Format
Built-In Placeholders
Shops