Installation
This guide walks you through installing zShop on your Minecraft server.
Requirements
| Requirement | Version |
|---|---|
| Minecraft | 1.13+ |
| Java | Java 21 (required) |
| Server Software | Paper, Purpur, or Folia |
| zMenu | Required dependency |
zShop requires zMenu to be installed. Install zMenu first before installing zShop.
Download
You can download zShop from:
- SpigotMC: https://www.spigotmc.org/resources/zshop.117583/
- Discord: Development builds available at discord.groupez.dev
Installation Steps
Step 1: Install zMenu
- Download zMenu
- Place
zMenu.jarin yourplugins/folder - Start your server to generate zMenu configuration
Step 2: Install zShop
- Stop your Minecraft server if it's running
- Place the
zShop.jarfile in your server'splugins/folder - Start your server
Step 3: Verify Installation
After starting your server, verify that zShop loaded correctly:
-
Check the server console for:
[zShop] zShop has been enabled! -
Run
/zshopin-game to open the shop
Step 4: Initial Configuration
After the first startup, zShop creates the following folder structure:
plugins/zShop/
├── config.yml # Main configuration
├── economies.yml # Economy definitions
├── commands.yml # Command definitions
├── inventories/ # Shop GUI configurations
│ ├── main_shop.yml # Main shop menu
│ ├── shop_buy.yml # Buy confirmation menu
│ ├── shop_sell.yml # Sell confirmation menu
│ ├── confirm.yml # Purchase confirmation
│ ├── buy_more.yml # Bulk purchase menu
│ └── categories/ # Shop categories
│ ├── blocks.yml
│ ├── ores.yml
│ ├── farms.yml
│ └── ...
├── patterns/ # Reusable zMenu patterns
├── players/ # Player limit data
├── logs/ # Transaction logs
└── limits.json # Server limit data
Configuration Overview
config.yml
Main plugin configuration including:
- Default economy
- Default item lore
- Price modifiers
- Logging settings
- Price formatting
See Configuration for details.
economies.yml
Define available economies:
- Vault integration
- Item-based currencies
- Experience/Level economies
- Third-party economy plugins
See Economies for details.
inventories/
Shop menus using zMenu format:
- Create custom shop categories
- Configure items with prices
- Set up confirmation dialogs
See Shop Items for details.
Optional Dependencies
zShop works with these economy plugins:
| Plugin | Integration |
|---|---|
| Vault | Standard economy support |
| PlayerPoints | Points-based economy |
| VotingPlugin | Vote points economy |
| TokenManager | Token economy |
| CoinsEngine | Multi-currency support |
| BeastToken | Token economy |
| PlaceholderAPI | Placeholder support |
Migrating from ShopGUI+
zShop includes a converter for ShopGUI+ configurations:
/zshop convert
About 90% of your ShopGUI+ configuration will be converted automatically. Some elements may need manual adjustment.
Updating
To update zShop:
- Download the latest version
- Stop your server
- Backup your
plugins/zShop/folder - Replace the old
zShop.jarwith the new one - Start your server
- Run
/zshop reloadif needed
Always backup your plugins/zShop/ folder before updating. Configuration formats may change between versions.
Troubleshooting
Plugin Not Loading
If zShop doesn't appear in /plugins:
- Check console for errors during startup
- Verify zMenu is installed and working
- Verify you're using Java 21:
java -version - Verify you're using Minecraft 1.13+
- Ensure you're using Paper (not Spigot)
Economy Not Working
If purchases/sales fail:
- Check
economies.ymlconfiguration - Verify the economy plugin is installed
- Check
defaultEconomyinconfig.yml - Look for economy errors in console
Items Not Appearing
If shop items don't show:
- Check YAML syntax in inventory files
- Verify material names are correct
- Run
/zshop reloadafter changes - Check console for loading errors
Getting Help
Need help?
- Discord: discord.groupez.dev - Fastest support
- GitHub Issues: Report bugs and request features
- Documentation: You're here!
Next Steps
- Configuration - Main configuration
- Economies - Set up economies
- Shop Items - Create shop items
- Commands & Permissions - Full command reference