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!
I really love your work and it's allmost perfect and does so much I wanted to have since the first time I created a shop with McEdit.
There is just one thing I don't like - when I remove your mod - the traders vanish. This is a hard problem to me because I do not want that my server world relies on mods - it is highly important to me that my world still works, even when your mod is possible not working with the actual minecraft version (anymore). So is there any possibility to make a custom trader to permanent 'normal' minecraft villager that has all the safed trades and dosen't move but cannot be changed anymore?
If there is nothing like this I would also ask to put this on the list of requested features.
In reply to Forge_User_39557435:
This won't work because the plugin handles the storage and trading logic all on its own. For instance, you can also setup non-villagers or sign shops and they provide the same trading interface as villagers. Your suggestion might only work if the plugin were limited to admin shops and villager shops. But even then there might be mechanics in vanilla minecraft that might break the shop once you trade with it a few times (eg. the villager chosing to add, remove, disable, or rebalance trades.. it's all up to minecraft's vanilla mechanics then what the villager decides to do).
As alternative you could look into modifying vanilla villager mobs via minecraft's commands. But that's not how this plugin works, so it is out of scope to incorporate a tool to simplify that into this plugin.
In reply to blablubb:
Well sad to me; but what I've expected.
I found this what helps me a lot; even if it has not that much trading offers as yours and the villiager is allways a normal villager it's better for my project. But what I know from this and my first by McEdit created shops is, that unlimited trading, no rebalancing and no more vinillia created trades seemes to be possible to creat.
Well at least thanks for your quick and detailed answer and good luck for your mod's future :D
Why a can't select chest for shopkeeper its still saying You cannot access the selected chest! please help
In reply to Forge_User_59597821:
To check if the player is owning the chest, the plugin asks other plugins if clicking the chest would succeed. Some of your other plugins is cancelling the chest interaction.
There are also plugins which have a 'invisible chest access mode' for admins which cancels the chest interaction and then invisibly to nearby players opens the chest inventory view for the clicking admin player. If this is the case, you have to exist this mode, since it conflicts with Shopkeepers 'does the player have access to this chest'-check.
In reply to blablubb:
ok thanks
when i buy villager eggs from the shopkeeper is there anyway i can make those villagers into normal ones instead of another shopkeeper villager?
In reply to Forge_User_06343486:
You can change the 'shop creation item' inside the config. You could for example use a different item, or require the item to have a specific name or lore to act as shop creation item.
is there a command that lets you switch a shopkeeper from spot? because i need to change 20+ shopkeepers from one building to another and it would be much easier if you could just do a command to place them somewhere else
In reply to Forge_User_62683789:
Nope. You can only modify the save.yml file directly currently to do that. Make sure to create a backup first though!
A player is using a signed book as a trade, 1 diamond for 8 books called "FosicCoins"
He then has another shop that allows you to use his "FosiCoins" books to trade for something else, such as 2 "Fosicoin" books for a stack of bones. This works fine, however it seems when a server restart happens, which we do daily, it breaks and the shops say the books are out of stock, even if they are in the chest, and other shops no longer recognize the books as a currency.
Once he re-edits his shops it works again, is there a reason to why the plugin would stop recognizing his books as a currency after a reload?
https://i.imgur.com/fsU4zEu.png
https://i.imgur.com/EuiKxcv.png
This shows it working fine, but later breaks when server reloads even when there is stock available, it only happens with books:
https://i.imgur.com/qL9Rh2Q.png
https://i.imgur.com/ZYjZ5jH.png
In reply to Forge_User_58132719:
Issue with Spigot's item serialization: https://hub.spigotmc.org/jira/browse/SPIGOT-3206
Basically: The book saved by the Shopkeeper won't match the original book once the Shopkeeper is reloaded. Since the book items don't match the trade no longer accepts the original book items. The fix would probably be for Spigot to save books in their original internal chat component format, instead of converting to legacy color codes (which cannot reliably be converted back to the original format)..
In reply to blablubb:
Thank you for the prompt response, much appreciated.
Hey!
i'd like to know if there's a way to set free items through admin shop.
Thanks.
In reply to lYuki_:
Nope. The trades always require some input item in exchange.
If I wanted the second currency to act as its own, would I put the following so the second currency doesn't automatically override?
In reply to Forge_User_58132719:
I don't think this is possible. The plugin does not separate between high and 'low' currency items when you setup the selling or buying trade. Instead it simply remembers a single 'price', which represents the combined low+high currency. And when converting from this price back to currency items it will use the low currency unless it is above the high-currency-min-value, in which case it will convert to high currency items.
Is there a configuration/permission to limit how many pages a player can use per villager?
By default it's 5 pages but I'd like to make it 1.
In reply to Forge_User_74434314:
Nope, it's hardcoded to 5 pages for all shops.
In reply to blablubb:
Damn, that's a shame.