💻guis.yml

The guis.yml file controls all GUI layouts, styling, and interactions in bShop. This centralized configuration allows you to customize the appearance and behavior of all shop interfaces.

Overview

The GUI configuration is divided into several main sections:

  • Main Menu - Shop category selection

  • Quantity Menu - Item quantity selection

  • Recent Purchases Menu - Transaction history

  • Bulk Stack Selection - Quick quantity options

Standard Actions

bShop provides predefined actions for GUI interactions:

Action
Description

wallet

Opens wallet info or does nothing

back_to_main

Returns to main menu

recent_purchases

Opens recent purchases GUI

recent_purchases_next

Next page in recent purchases

recent_purchases_prev

Previous page in recent purchases

shop:%shop%

Opens the specified shop

Standard Placeholders

Use these placeholders in display names and lore:

Placeholder
Description

%item%

Name of the item

%amount%

Amount bought/sold

%price%

Price of the transaction

%type%

Buy/Sell

%date%

Date of transaction

%shop%

Name of the shop

%transaction_id%

Unique transaction ID

%balance_after%

Player's balance after transaction

The main menu is the central hub for accessing different shop categories.

Basic Structure

Configuration Options

Property
Type
Required
Description

title

String

Yes

GUI window title

size

Integer

Yes

GUI size (1-6, representing 9-54 slots)

items

Map

Yes

Shop category items

filler

Object

No

Filler item configuration

Item Configuration

Each item in the main menu represents a shop category:

Item Properties

Property
Type
Required
Description

material

String

Yes

Minecraft material name

slot

Integer

Yes

GUI slot position (0-53)

display-name

String

Yes

Item display name (supports MiniMessage)

lore

List

No

Item description lines

action

String

Yes

Action to perform when clicked

base64-head

String

No

Base64 encoded player head texture

texture

String

No

Player head texture URL

Special Items

Wallet Item

Recent Purchases Item

Filler Configuration

Filler items fill empty slots in the GUI:

Quantity Menu Configuration

The quantity menu allows players to select how many items to buy or sell.

Basic Structure

Display Item Configuration

The display item shows what the player is buying/selling:

Display Item Placeholders

Placeholder
Description

%item%

Item name

%quantity%

Selected quantity

%price_per_item%

Price per individual item

%total_price%

Total price for selected quantity

Button Configuration

Quantity adjustment buttons:

Action Buttons

Confirm Button

Cancel Button

Bulk Options Button

Bulk Stack Selection GUI

The bulk stack selection provides quick quantity options.

Basic Structure

Stack Items

Each stack item represents a quantity option:

Stack Item Properties

Property
Type
Required
Description

material

String

Yes

Minecraft material name

display-name

String

Yes

Buy display name

sell_display-name

String

Yes

Sell display name

lore

List

No

Item description

slot

Integer

Yes

GUI slot position

amount

Integer

Yes

Number of stacks

action

String

Yes

Action with quantity parameter

Back Button

Recent Purchases Menu

The recent purchases menu shows transaction history.

Basic Structure

Purchase Items

Each purchase item shows a transaction:

Previous Page

Next Page

Back Button

Wallet Button

Last updated