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!
Hi,
I'm updating from 2.4.1 to latest release on 1.13.2. Just wondering if theres anything I need to do other than backup my data?
In reply to Forge_User_23917930:
You might want to let the default config regenerate due to the many message changes in v2.6.0
In reply to blablubbabc:
Thank you for the quick reply, update seems to have gone okay. One other question, does tax work if you sell items for items? And what setting in config is to stop shopkeeper villagers acting like normal villagers(to stop people buying shopkeepers and using for iron farms)
In reply to Forge_User_23917930:
"does tax work if you sell items for items?"
Looking at the code I would say yes, the taxes also apply for the trading player shopkeepers.
"what setting in config is to stop shopkeeper villagers acting like normal villagers(to stop people buying shopkeepers and using for iron farms)"
I believe for iron golum farms to work it is required for the spawned villagers to search for nearby villages / doors they can add as member. If you are not using the legacy-mob-behavior (there is a by-default disabled setting for this in the config), then all the spawned villagers will have their AI disabled, which I believe should also disable their 'search for villages' behavior and thereby making them not applicable for iron golum farms.
But I would have to check to verify this. Other than that I am not aware of any other setting regarding this.
In reply to blablubbabc:
Sweet so if someone sells something for 10 diamonds and theres a 10% tax, tax removes 1 diamond? and does tax happen on the buyer or seller?
And would there be a way to check how much tax has taken out of the server if I were to enable it?
And by any chance have you got a discord, a server or perhaps just your discord ID?
In reply to Forge_User_23917930:
"Sweet so if someone sells something for 10 diamonds and theres a 10% tax, tax removes 1 diamond?"
Yes. But there might be trades in which depending on the item counts, tax rate and rounding rule there might be no tax. The exact tax calculations can be found here: https://github.com/Shopkeepers/Shopkeepers/blob/master/src/main/java/com/nisovin/shopkeepers/ui/defaults/TradingHandler.java#L663
"and does tax happen on the buyer or seller?"
The amount is removed from the seller's earnings.
"And would there be a way to check how much tax has taken out of the server if I were to enable it?"
No. But you might be able to calculate it from the trading logs. Or you log it yourself with some add-on plugin after every trade.
"And by any chance have you got a discord, a server or perhaps just your discord ID?"
Nope, I am not using discord.
Hello, I have a problem.
I want to use emeralds with the name 'Honor of Digging', bold and non-italic, colored with dark aqua for trade. I use the give command to get this, but if I trade it after setting it as an exchange item, these are not judged to be the same item. I checked save.yml and searched for the cause, but I did not know the solution because there are colored and bolded with color code instead of json syntax.
How can I solve this?
Command to get 'Honor of Digging': give @s minecraft:emerald{display:{Name:"{\"text\":\"Honor of Digging\",\"color\":\"dark_aqua\",\"bold\":\"true\",\"italic\":\"false\"}"}}
Displayed item name in save.yml: §3§lHonor of Digging
I wrote this using Google Translation, so I apologize if you can't understand me.
In reply to Existence89:
Two things:
* The "correct" syntax (what spigot normalizes the item to after dragging the item around in the inventory) might be: minecraft:emerald{display:{Name:"{\"text\":\"Honor of Digging\",\"color\":\"dark_aqua\",\"bold\":true,\"italic\":false}"}} (without the quotes on the boolean values).
* Regardless of the first point, I think this might be a spigot issue, so maybe create a ticket and see what they have think about this. The problem: Spigot seems to serialize the item in its legacy representation (using legacy color codes "§3§l"). And when deserializing it again, it will no longer have the same chat-component based representation, and will therefore not match. Unfortunely I don't think you are able to create the legacy-variant with the give command, which I assume only supports the chat-component based representation..
Edit: Actually, you can with 'give @p minecraft:emerald{display:{Name:"{\"text\":\"\\u00A73\\u00A7lHonor of Digging\"}"}}'. However, this still does not match the normalized variant of the item (the variant spigot creates once it interacts with the item).
A work-around could be to instead use a plugin to create the item with formatted name.
In reply to blablubbabc:
Thanks for your swift reply. I corrected command syntax (remove quotes from boolean values with quotes) and try to trade again, this problem is no longer raised. The reason this problem has occurred is my wrong command syntax. I'm sorry for my ignorance.
Thanks a lot!
Edit: After a while, this problem has occurred again. So I changed the command sentence (item name with \\u00A7 code), it seems working.
In reply to Existence89:
The problem is that Spigot will occasionally 'normalize' / convert the item's internal representation, and you are not able to create this normalized variant directly with the minecraft command. For example, if your drag the item around in the inventory, Spigot normalizes the item representation. And additionally, when Shopkeepers saves and loads the item to/from the save.yml file (using Spigot's API) the representation gets converted using the legacy formatting codes.
So to get a normalized item with legacy formatting codes, you either have to create the item with a plugin, or create the item with the \\u00A7 codes AND then drag the item around in the inventory at least once.. (which can often happen accidentially, so you often don't notice). If you forget to drag the item around in the inventory however, you will run into this problem again.
In reply to blablubbabc:
I checked with NBTExplorer, the "emerald" which was unavailable to trade had the name displayed "\\u00A73\\u00A7lHonor of Digging", so I noticed system don't think this emerald and the emerald which villager presents as requirement are same, as you said.
In Minecraft chat and command block line I can't use section sign, so I made the function and executed this, I could be obtained the emerald which name was already converted. Of course the problem didn't occur no longer.
Is there a way to sell multiple stacks at a time? Such as 1 Emerald for 4 stacks of dirt? If not are there plans to add this?
In reply to agentalex367:
Nope. Shopkeepers only allows setting up the trades, it does not fundamentally change how the trading in minecraft works.
Hello, I have a question, on my server I want to create a special exchange, example: a block of wood called "Special wood" but I need people to change that special wood, only work with that item, not put a wood normal and still accepts the exchange .. thanks
In reply to zapeesz:
Minecraft should already only allow the trade if the offered and the required items match (including having the same name).
Which version of minecraft are you running the plugin with?
In reply to blablubbabc:
I think you have not understood me, what I need to do is the opposite of what you have told me, I want to create a special item that can be exchanged only with that item, example: a shop owner offers 10 emeralds in exchange for 5 "Special Wood", I need those supposedly special woods to be obtained in a different way, and the people basically to make the exchange put in normal wood and the shopkeeper exchanges it, you understand me?
In reply to zapeesz:
So you have a trade 5x SpecialWood -> 10 emeralds. And you want the trade to work with regular wood? That's not possible then. Shopkeepers only configures minecraft trades. It does not change the trading logic. So if minecraft is not allowing this trade, neither will Shopkeepers.
In reply to blablubbabc:
So, what I want to do can not be done? Special wood was an example, what I am doing is a swap of X Apollo Ball ---> peak with special enchantments.
This apollo ball is a magma cream (with a name and glow)
But when users want to get this peak, instead of putting the requested apolo balls, they put magma cream.
Thank you for responding so quickly, I congratulate you for your work.
In reply to zapeesz:
Yes, this does not work. The trade will require exactly the displayed item. You have to either require regular maga cream items in the trade, or somehow give your players those special 'Apollo Ball' items, or allow them to exchange between regular and special magma cream items.
Is there a perm or command where players can place a villager as a normal villager and not a shopkeeper?