Quick Start Guide

Quick Start Guide

Get GUIShop up and running in minutes with this quick start guide.

Step 1: Install Dependencies

1. Install Vault plugin
2. Install an economy plugin (EssentialsX, CMI, etc.)
3. (Optional) Install PacketEvents for worth display

Step 2: Install GUIShop

1. Download GUIShop
2. Place in your plugins folder
3. Restart the server

Step 3: Basic Configuration

GUIShop comes with example shops. To customize:

Edit shops.yml

Open plugins/GUIShop/shops.yml and modify the example shops:

shops:
  Blocks:
    pages:
      Page0:
        '0':
          type: SHOP
          id: STONE
          buy-price: 10
          sell-price: 5
          shop-name: '&7Stone'
        '1':
          type: SHOP
          id: COBBLESTONE
          buy-price: 5
          sell-price: 2
          shop-name: '&7Cobblestone'

Edit menu.yml

Configure the main menu in plugins/GUIShop/menu.yml:

menu:
  pages:
    Page0:
      '4':
        id: GRASS_BLOCK
        shop-name: '&aBlocks Shop'
        target-shop: 'Blocks'
        shop-lore:
          - '&7Click to browse blocks'

Step 4: Apply Changes

/gs reload

Step 5: Test

1. Type /shop to open the menu
2. Click a shop to browse items
3. Click an item to buy
4. Type /sell to open sell GUI

Common Tasks

Add a New Shop

1. Add to shops.yml:

shops:
  MyNewShop:
    pages:
      Page0:
        '0':
          type: SHOP
          id: DIAMOND
          buy-price: 100
          sell-price: 50

2. Add menu entry in menu.yml:

'5':
  id: DIAMOND
  shop-name: '&bMy New Shop'
  target-shop: 'MyNewShop'

3. Reload: /gs reload

Add Sell-Only Items

Set buy-price: false to make items sell-only:

'10':
  type: SHOP
  id: ROTTEN_FLESH
  buy-price: false
  sell-price: 1

These items will not appear in shops but can be sold.

Add Command Items

Sell commands instead of items:

'20':
  type: COMMAND
  id: NETHER_STAR
  shop-name: '&6VIP Rank'
  buy-price: 10000
  commands:
    - 'lp user {PLAYER_NAME} parent set vip'

Enable Worth Display

1. Install PacketEvents
2. Set enabled: true in worth.yml
3. Restart server

Items will now show their sell value in lore.

In-Game Item Editor

GUIShop includes a powerful GUI-based editor for configuring shops without touching config files:

1. Run /gs edit to edit the menu, or /gs edit <shop> for a specific shop
2. Left-click items to drag and rearrange them
3. Right-click or Shift+click any item to open the Item Editor GUI
4. Click on any setting (buy price, sell price, name, etc.) to modify it
5. Type values in chat when prompted (supports formats like 1k, 1.5M, 100B)
6. Changes save automatically when you close the inventory

Quick Item Setup

• Drag an item from your inventory into the shop
• Right-click it to open the editor
• Set prices and the item becomes purchasable!

See In-Game Item Editor for detailed documentation.

Item Info Command

Use /gs iteminfo while holding an item to see its complete configuration in a format ready to paste into shops.yml. Great for potions, enchanted items, and spawners!

Next Steps

• Read Shop Configuration for advanced options
• See Special Item Configurations for potions, spawners, etc.
• Check Commands and Permissions for all available commands