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 |
BadWolfMC |
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 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. You need to check for yourself whether they are still up-to-date and compatible with the latest Shopkeepers version. 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.
- Shopkeepers List: Adds commands and inventory-based GUIs to browse shops and find shops that trade a specific item.
- ShopkeepersNavAddon: 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!
@wawaamp
WorldGuard has a configuration option to set exactly which creature types you want to block (mobs/block-creature-spawn). There's also a setting to not block spawns from plugins (mobs/block-plugin-spawning).
Hello.
i must apologise in advance for bringing you this while everyone else is bringing you bugs. so, sorry.
Is there any way you can set this up to bypass worldguard protection regions? because the mob-spawning deny flag stops these little fellas appearing and since i want spawn to be monster-free, i kinda need that flag.
thanks.
I couldn't narrow it down to one particular plugin, but it seems to happen more often as server load increases with more plugins. Opening a villager trade window over and over repeatedly seems to cause the issue as well, and it happens more as the server gets loaded with more plugins. I'll test with regular villagers as well.
EDIT: I'm having the same problem with regular villagers, without the ShopKeepers plugin running. Looks like it's either a weird multi-plugin interaction, or a CB issue.
Looks like you're off the hook on this one nisovin!! :)
@nisovin
Uh oh, now I feel silly... I tried disabling all plugins before you edited your comment, because I was having the same result with both 1.1 and the version you just posted... It does in fact look to be a plugin interaction. Looks like others are having the same problem though, so I'll re-enable them one by one to find which one is causing the problem.
@Darkhand81
Try this version and let me know if it fixes it:
http://nisovin.com/Shopkeepers.jar
If not, please update to the latest Craftbukkit, remove all other plugins, and see if it still happens.
@nisovin
No message, just can't right click or shift-right click on him. Villager is still invulnerable, and I can still push him around (he does pop back to his original position as well).
Tried trading with another shopkeeper villager, once I log out and back in I can once again interact with the first villager, but I can no longer interact with the second one.
EDIT: I even tried rearranging the position of the shopkeeper's data in save.yml... Manually made the broken shopkeeper (number 2 in save.yml), number 3, and number 3 number 2. No change, the same villager is still unclickable (until I complete a trade with another one and relog).
FWIW, it's a Linux server and here's the result of java -version:
@RasCas
Of course you can put shopkeepers next to each other.
@Darkhand81
Are you getting the message that says someone is already using that villager, or does it just not do anything? Is the villager killable?
is it possible to have more than 8 different items to trade per shopkeeper? If not, may i create shopkeepers next to each other?
@Tobias2289
For me, even if I shut down the server, disable the plugin, restart, shutdown again, enable the plugin, and start back up... I still can't interact with the last villager I traded with. :(
I'll try your suggestion of interacting with another villager first though!
EDIT: Tried trading with another shopkeeper villager, once I log out and back in I can once again interact with the first villager, but I can no longer interact with the second one. I'll update the ticket.
@np98765
To you and everyone else, if your having the problem of not being able to access a villager after trading or opening up the trade window try to open up another villagers trade window and then exit and go back to the one you want.
Also seems to be a bug where the only way to access one is to restart I've only seen this once sofar and not sure what I did to cause this.
Hope this helps in some way.
@draccydragon
Written books are still supported on admin shops, but not on player shops.
Just a heads up:
A lot of the 'unable to click' symptoms below are due to unique types of lag caused by the unstable bukkit builds. The same problem prevented pushing buttons, getting in minecarts, killing enemy mobs, etc.
I noticed you say written books aren't supported. I had great success with written books in that development snapshot you had up. What has changed?
@dotapurex1
Every day I go through the first two or three pages of server mods (in the top left corner) to see what's been up dated. I'm always searching for new plugins and ideas.
Where would you find this plugin anyways? I didn't notice it until i saw it on another server and searched it on google.
One feature I strongly believe should be implemented is the ability to limit the amount of shops groups/people can create!
Very nice plugin, by the way!
This is fantastic, I didn't even expect to see a plugin like this until after the villager API came out. Wow!
I can stop manually editing the NBT data of all my trader-villagers with MCEdit, and stop blocking them in with fences!
Trying 'er out now!
EDIT: A few things I've found:
-If you load up the shopkeeper editor with items and close it without clicking the emerald block button, you lose all the items you placed into the editor.
-I somehow managed to bug one of my shopkeepers and couldn't get him to open his shopkeeper editor window. I ended up manually removing him from my save.yml since I could no longer open his window to get to the delete button. A /shopkeeper delete command that deletes the shopkeeper you're looking at might make for a good backup.
EDIT TO THE EDIT: The reason I couldn't interact with the villager is because it seems that after you trade once, you're no longer able to interact with that particular NPC after logging out and back in. I have to delete his entry in save.yml otherwise I can't open their trade or editor windows.
On my server, I cant change trade to diamond or something like, when I click on the item, he goes back to my inventory.
I Want make trade 1 Diamond + I Iron Ingot to 1 Emerald.
@nisovin
I set the Admin shopkeeper to sell a blink scroll and so the first time someone tries to buy a scroll from the NPC it is the blink scroll, but after that its just paper. I'm assuming once you have things well in hand here your going to make it work better with scrolls and tomes from MagicSpells?
@fuzyfeet
Ah! Thanks I understand it now. It was that simple I feel numb haha. Awesome!