Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ShopUI

ShopUI is a form-based item shop plugin for PowerNukkitX. Players can browse configurable categories, select an item and quantity, review the total price, and complete the purchase using their economy balance.

Requirements

ShopUI will load without LlamaEconomy because it is declared as a soft dependency, but the shop cannot process purchases until an economy provider is available.

Installation

  1. Download ShopUI
  2. Install and configure LlamaEconomy.
  3. Copy ShopUI.jar into the server's plugins directory.
  4. Start the server once to generate the default configuration.
  5. Edit plugins/ShopUI/config.yml to configure the shop.
  6. Restart the server after changing the configuration.

Usage

Players can open the shop with:

/shop

The command can only be used by a player.

Configuration

The complete default configuration includes ready-to-use examples. A minimal shop looks like this:

max-purchase-steps: 16

categories:
  building_blocks:
    name: Building Blocks
    icon: textures/blocks/stone
    entries:
      stone:
        item: 'minecraft:stone'
        amount: 16
        buy: 25
        custom-name: Special Stone
        thumbnail: textures/blocks/stone

Global settings

Setting Description Default
max-purchase-steps Maximum number of options shown in the quantity slider. Values below 1 are treated as 1. 16

Category settings

Setting Required Description
Category ID Yes Unique YAML key used internally, such as building_blocks.
name No Display name. If omitted, the category ID is formatted automatically.
icon No Bedrock resource-pack texture path used by the category button.
entries Yes Section containing the purchasable items.

Item settings

Setting Required Description
Entry ID Yes Unique YAML key inside its category. It is also used as the default display name.
item Yes PowerNukkitX item identifier, for example minecraft:stone.
amount Yes Number of items in one package and the increment used by the quantity slider. Must be between 1 and 64.
buy Yes Price of one package. Must be zero or greater.
custom-name No Custom name applied to the purchased item and shown in the shop.
thumbnail No Bedrock resource-pack texture path used by the item button.

Quantity slider

The slider works with packages rather than individual items. For an entry with amount: 16, the available quantities are 16, 32, 48, and so on.

The number of options is limited by:

  • max-purchase-steps
  • The player's current balance
  • Safe item-count and price limits

The player's balance and inventory space are checked again when the purchase is confirmed.

Languages

ShopUI automatically uses the player's language and falls back to English. The following languages are included:

  • English
  • Chinese (Simplified)
  • French
  • German
  • Italian
  • Japanese
  • Korean
  • Portuguese (Brazil)
  • Russian
  • Spanish
  • Turkish

About

Create a simple shop for your players

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages