Table of Contents

1. Installation
2. Configuration
3. Commands
4. Permissions
5. Shop Configuration
6. Storage Setup
7. API Usage
8. Placeholders
9. Troubleshooting

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Installation

Step 1: Download
Download the latest ShopGuiNEXT-0.1.0-SNAPSHOT.jar from the resource page.

Step 2: Install Dependencies (Optional but Recommended)
• Vault - Required for economy integration
• PlaceholderAPI - Required for placeholder support

Step 3: Place JAR File
1. Stop your server
2. Place ShopGuiNEXT-0.1.0-SNAPSHOT.jar in your plugins folder
3. Start your server

Step 4: First Run
On first run, the plugin will generate:
• plugins/ShopGuiNext/config.yml
• plugins/ShopGuiNext/shops.yml
• plugins/ShopGuiNext/messages_tr.yml
• plugins/ShopGuiNext/messages_en.yml
• plugins/ShopGuiNext/languages.yml

Step 5: Configure
Edit config.yml and shops.yml according to your needs.

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

⚙️ Configuration

config.yml

# Storage Type: 'file' or 'mysql'
storage-type: file

# MySQL Configuration (only if storage-type is mysql)
mysql:
host: localhost
port: 3306
database: shop
username: root
password: password

# Dynamic Pricing Settings
dynamic-pricing:
enabled: true
multiplier: 0.1
min-price: 0.01
max-price: 1000000.0

# Stock Reset Settings
stock-reset:
enabled: true
time: "00:00"

shops.yml Structure

categories:
category_id:
displayName: "&aCategory Name"
icon: MATERIAL_NAME
slot: 10
items:
- item_id_1
- item_id_2

items:
item_id:
item:
material: MATERIAL_NAME
amount: 1
name: "&aItem Name"
basePrice: 10.0
canBuy: true
canSell: true
stock: -1
dailyLimit: 128
category: category_id

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Commands

Player Commands:

/shop
Opens the main shop menu showing all available categories.
Permission: shop.next.use (default: true)

/shop <category>
Opens a specific category menu.
Examples: /shop blocks, /shop tools, /shop weapons
Permission: shop.next.use

/shop language <tr|en>
Changes your language preference.
Examples: /shop language tr, /shop language en
Permission: shop.next.use

/shop search <query>
Searches for items by name.
Examples: /shop search diamond, /shop search sword
Permission: shop.next.use

Admin Commands:

/shopadmin
Opens the admin panel for managing categories and items.
Permission: shop.next.admin (default: op)

/shop reload
Reloads all plugin configuration files.
Permission: shop.next.reload (default: op)

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Permissions

Player Permissions:
• shop.next.use - Use the shop commands (default: true)
• shop.next.buy - Purchase items (inherits from shop.next.use)
• shop.next.sell - Sell items (inherits from shop.next.use)

Admin Permissions:
• shop.next.admin - Access admin panel (default: op)
• shop.next.reload - Reload plugin configuration (default: op)
• shop.next.edit - Edit shop items and categories (inherits from shop.next.admin)
• shop.next.* - All permissions (default: op)

Permission Examples:

Give player access:
/lp user PlayerName permission set shop.next.use true

Give admin access:
/lp user AdminName permission set shop.next.admin true

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Shop Configuration

Creating a Category:

1. Open shops.yml
2. Add a new category under categories:

categories:
my_category:
displayName: "&6My Category"
icon: DIAMOND
slot: 20
items:
- item1
- item2

Slot Numbers:
• Slots 0-8: Top row
• Slots 9-17: Second row
• Slots 18-26: Third row
• Slots 27-35: Fourth row
• Slots 36-44: Fifth row
• Slots 45-53: Bottom row

Adding an Item:

1. Open shops.yml
2. Add item under items:

items:
my_item:
item:
material: DIAMOND_SWORD
amount: 1
name: "&bDiamond Sword"
lore:
- "&7A powerful sword"
basePrice: 100.0
canBuy: true
canSell: true
stock: -1
dailyLimit: 16
category: my_category

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Storage Setup

YAML Storage (Default):
No configuration needed! The plugin uses YAML files by default.

MySQL Storage:

1. Edit config.yml:
storage-type: mysql
mysql:
host: localhost
port: 3306
database: shop
username: root
password: your_password

2. Create the database:
CREATE DATABASE shop;

3. Restart your server - the plugin will create tables automatically.

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

API Usage

For Developers:

Getting ShopService:
ShopService shopService = ShopGuiNextPlugin.getInstance().getShopService();

Getting an Item:
ShopItem item = shopService.getItem("diamond_sword");
double price = shopService.getCurrentPrice("diamond_sword");

Purchasing an Item:
try {
boolean success = shopService.purchase(player, "diamond_sword", 1);
} catch (ShopException e) {
player.sendMessage("Error: " + e.getMessage());
}

Available Events:
• ShopPurchaseEvent - Fired when a player purchases an item
• ShopPriceChangeEvent - Fired when an item's price changes
• ShopStockChangeEvent - Fired when an item's stock changes

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Placeholders

PlaceholderAPI Integration:

If PlaceholderAPI is installed, you can use these placeholders:

• %shopguinext_price_<item>% - Current price of an item
Example: %shopguinext_price_diamond%

• %shopguinext_balance% - Player's balance
Example: %shopguinext_balance%

• %shopguinext_stock_<item>% - Stock of an item
Example: %shopguinext_stock_diamond%

• %shopguinext_sellprice_<item>% - Sell price of an item
Example: %shopguinext_sellprice_diamond%

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Troubleshooting

Common Issues:

Shop menu doesn't open:
• Check: Do you have shop.next.use permission?
• Check: Is Vault installed? (Required for economy)

Items not showing:
• Check: Is shops.yml properly formatted?
• Check: Run /shop reload after editing shops.yml
• Check: Are items assigned to categories?

Prices not updating:
• Check: Is dynamic pricing enabled in config.yml?
• Check: Are transactions being logged?

Language not changing:
• Check: Is languages.yml writable?
• Check: Run /shop reload after changing language

MySQL connection errors:
• Check: Database credentials in config.yml
• Check: Database exists and is accessible
• Check: MySQL server is running

Debug Mode:

Enable debug logging in config.yml:
debug: true

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Notes

• All prices are in your economy currency (Vault)
• Stock resets at midnight (configurable)
• Daily limits reset at midnight
• Prices update in real-time
• GUI updates every 20 ticks (1 second)

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Last Updated: November 2025
Plugin Version: 0.1.0
Author: NrleryxDev