Shopkeepers
Set up custom villager shopkeepers that sell exactly what you want them to sell and for what price. You can set up admin shops, which have infinite supply, and you can also set up player shops, which pull supply from a chest.
It will also prevent any other trades with non-shopkeeper villagers, if you want it to.
For those who are simply looking for a convenient way to modify the trades of vanilla villagers (as an alternative to using complex Minecraft commands), the plugin also includes a graphical editor for regular villagers and wandering traders.
Basic Features
- Easily create villager shopkeepers that trade the items you want them to trade.
- Admins shops with infinite supplies.
- Player shops which pull supplies from a chest.
- Different types of player shops: selling, buying, trading, and selling books.
- Various supported mob types to represent your shopkeeper, sign shops, and Citizens (NPC) shops.
- Editor for regular villagers and wandering traders.
- Many configuration options.
- Translatable messages.
- Open source (Source code on GitHub)
Supported server versions
Shopkeepers supports the latest versions of Bukkit / Spigot.
Note that this plugin is created to work with CraftBukkit (or alternatively Spigot). Bukkit does not have an API for some of the things necessary to make this plugin work. This means that other server software (Tekkit, Forge, Cauldron, etc.) will not work with this plugin.
Other CraftBukkit or Spigot derivatives/forks might work, but are not officially supported. So if you run into issues while using those, try to reproduce your issue on a fresh and up-to-date Spigot server first.
Getting started
All documentation can be found in the wiki:
- Downloads and changelogs for all files
- Installation
- Translations
- Configuration
- Permissions
- Creating shops
- Commands
- Frequently Asked Questions
Showcase
Admin shops:
Configure the trades via the in-game inventory menu:
Resulting trading menu:
Player shops (ex. selling items):
Fill the shop chest with supplies:
Configure the trades via the in-game inventory menu:
Resulting trading menu:
Video Tutorials
More video tutorials can be found in the wiki: https://github.com/Shopkeepers/Shopkeepers-Wiki/wiki/Video-Tutorials
Tutorial by Donnie, explaining the setup of the different shop types:
Tutorial by Fan Staaff showing the setup of the different shop types in detail:
Tutorial by LastKing2X,showing the setup of the different shop types:
Spanish tutorial by Ajneb97, also mentioning placeholder items and various config options:
Statistics
This plugin uses bStats to collect anonymous plugin usage statistics. This helps me to determine how many servers are using the plugin, which Minecraft versions it is used with the most, and to which degree the different features are used.
Here is a list of all currently tracked information:
- Common information: The number of servers using the plugin, the number of players on these servers, online mode, Minecraft version, plugin version, core count, system arch, operating system, server country, Java version.
- Shopkeepers specific information: Whether specific related plugins are used (Citizens, Towny, WorldGuard, Gringotts, other Vault economy plugins), number of shops, whether player shops are used, whether certain features are enabled in the config (ex. WorldGuard/Towny compatibility, Citizens shops, delayed saves, colored names, chest protection, removal of inactive shops, tax rate, strict item comparison, purchase logging, disabling of other villagers, ..), the number of worlds containing shops.
- All information can be publicly viewed here: https://bstats.org/plugin/bukkit/Shopkeepers/
If you want to disable bStats for all plugins on your server, edit the file plugins/bStats/config.yml, or alternatively disable it only for Shopkeepers by setting 'enable-metrics' to 'false' inside the Shopkeepers config.
Known potential issues
A list of known potential issues of the latest version of Shopkeepers can be found in the wiki: This documents differences between Minecraft/Spigot versions, and existing Minecraft/Spigot issues related to Shopkeepers.
If you run into an issue, check if this list already contains and maybe offers information on how to handle it.
Have issues or further questions?
If you have a pressing issue or simple question, you can join the discord server and ask other plugin users for help:
But submitting a ticket is the best way to get help or report a problem with the plugin.
Before submitting a ticket:
- Check if your question is already answered in:
- The documentation (wiki).
- The FAQ.
- The Known Issues.
- Check if there is already another ticket for your issue.
Before reporting an issue:
- Try to reproduce your issue when using:
- The latest versions of Spigot and Shopkeepers.
- No other plugins.
- No kinds of other server or client mods.
When reporting an issue:
- Provide the versions you are using of Minecraft, Spigot and Shopkeepers.
- Provide a detailed description of your problem and add as much information as possible which could help reproducing the issue.
- If possible, include step-by-step instructions on how to reproduce the issue on a fresh Spigot server.
Donations
If you like this plugin, consider supporting its developers by making a donation:
- To blablubbabc (current maintainer: Dec 2013 - today)
- To nisovin (former author: Aug 2012 - Dec 2013)
A big "thank you" to everybody who is keeping the motivation up through donations!
Minecraft-Servers-Listing.com | TRS Game Servers | terminalserver.us |
Minewind | mercurialmusic | timitimitimi |
FatherWh0 (merchantvillages.com) | lukeeexd (tws-mc.com) | PapaJuan |
EmeraldHaze (Ninjalette) | Espen | kbtalkin |
Dimo (Beyond Vanilla) | RefugiaCraft | Frilioth |
Tabletopcheese | Observant Minecraft Server | Ren Binden |
Want to help?
The less I have to do myself, the more time I have to write plugins. Therefore I am looking for someone who would be willing to get involved in the project. That could for example mean:
- Keeping the documentation (the wiki) up-to-date with plugin updates.
- Improving the existing documentation.
- Creating and maintaining translations.
- Help managing issues and answering questions of users.
If you are a programmer with experience in writing bukkit plugins, or have ideas on how you can contribute to the project beyond that, let me know as well! If you are interested, feel free to contact me via PM.
Beyond that, everybody is invited to help others with issues and questions in the issue tracker, comment section, and the discord channel! Also consider contributing translations!
Third-Party Add-On Plugins
Sometimes a feature is either to specific to include it directly into the Shopkeepers plugin, or I did not yet have the time to add something similar myself. The plugins listed here extend the functionality of the Shopkeepers plugin.
These plugins are maintained by other community members. If you run into issues while using any of these add-ons, try to first reproduce your problem without any add-ons before you report it.
ShopkeepersNavAddon(abandoned): Adds inventory-based GUIs that allow you to browse all player shops, all admin shops, and to find shops that trade a specific type of item. You can teleport to a particular shopkeeper by clicking a button inside the GUI.
This plugin also integrates support for trading with Vault-based currency, but does so by replacing Shopkeepers' normal trade handling.
If you have also written an add-on plugin and want it listed here, let me know!
Oh wise Nisovin, you did so much, why not add an api???
You can find the source code on github. It's not officially supported (don't report issues if you have a plugin doing this), but a bunch of methods are public, so you can access them from other plugins.
I meant an api, like you know, a simple api
I am not sure what exactly you are looking for, but there is for example this as starting point: https://github.com/nisovin/Shopkeepers/blob/master/src/main/java/com/nisovin/shopkeepers/ShopkeepersAPI.java
An many of the public methods have javadoc comments as well.
Though, like I already said, not yet supported. But you can already experiment around with it and create pull requests if something you need is missing.
well you just made my life 1000X easier
@blablubbabc
Thank you ! I searched for documents about the regex with Chinese and I solved the problem with regex [\u4e00-\u9fa5A-Za-z0-9 ]{3,25} . I have tested and that works.
@blablubbabc I created the ticket and i provided the log. I also tried updating everything but issues seems to remain the same.
https://dev.bukkit.org/bukkit-plugins/shopkeepers/tickets/448-shopkeepers-not-showing-custom-items/
Hi, sorry to keep asking for help regarding the same problem but i have already updated my server to the latest Craftbukkit and it keeps not working. is there maybe a file i need to erase from the folder that might be tricking it to not see the latest version ?
by the way i pay for the server to be hosted by GGservers idk if that might help in any way.
You need a version which was built from the official spigot sources the 22.11.2016 or later. If you run the command '/version' it should display you how many versions you are behind the latest version.
The server host shouldn't matter as long as you are able to upload the latest server binary.
@IXinXuan
It is possible. You will have to edit the naming regex in the config: This value limits the set of allowed characters. I haven't tested it, but googling 'java regex chinese' suggests adding '\p{Han}' to the regex.
Great Plugin !!! But I am wondering if the plugin can support Chinese as the shop name? Thx!
@Skabroon
Create a ticket and attach the log file there. However, I highly assume you have the same 'issue' as in this ticket: https://dev.bukkit.org/bukkit-plugins/shopkeepers/tickets/447-bug-on-shop-keeper/#comments
Solution: Update to a newer version of spigot / bukkit 1.11.
@blablubbabc
Hi, i have it on the latest version available and running it on bukkit.
i have the log from the console, how do i provide that here ?
it seems like pasting the entire is too much and long text.
@blablubbabc Ticking has been a problem with older spigot and older version of citizens.
@DerpingGreen
Works fine fo me on 1.11
I run my server on bukkit 1.11 is that the problem? because it worked on bukkit 1.10
@LillyAnna87
There are updated versions of spigot 1.11 available each day. Make sure that you are not using an early 1.11 version, but a freshly built one, with all the very latest changes.
@blablubbabc
Thanks for answer. Looks like it's problem with Spigot, not your plugin.
I am running the latest spigot on my host. spigot-1.11. I cant find a newer one?
@Skabroon
@LillyAnna87
See https://dev.bukkit.org/bukkit-plugins/shopkeepers/tickets/446-cant-open-shopkeeper-menu/#c1
@Skeletino
I have no idea why ticking villagers takes that long on your server. The timings on my testing server (with 30 shopkeepers) are quite lower (https://timings.spigotmc.org/?url=rabuxedayi). Maybe try it again with the latest version of spigot and see if that fixes it. Anyways, I am not sure how Shopkeepers might be causing this. Shopkeepers even removes most AI goals from the spawned entities (besides the one causing them to float on water and the one repsonsible for looking at nearby players), so I would even assume their ticking time to be slightly less then the one of default villagers.