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!
@nisovin
Ok, thanks.
@demellion
That's not what that option handles. Spawning shops should never have worked in regions with mob spawning disabled, so it was probably a WorldGuard bug. See the FAQ.
enable-world-guard-restrictions: false. Shops do not spawn in WG regions with "mob-spawning: deny" flag. Do not work anymore, worldguard seems like updated.
P.S on 1.4.7 they were spawning no matter what.
Okay, another test version. This one is compatible with Minecraft 1.5.1. This file is a test version, it is not approved by the BukkitDev staff, use it at your own risk.
@Vitaminous
I don't auto-disable it just for fun. There is no Bukkit API for what I do in this plugin. With updates like this, the CraftBukkit code changes. If I didn't auto-disable the plugin, it would just spam errors and not work until you decided to disable it yourself. This way is better.
@JohnCraft110
You cannot buy items from your own chest.
@rpundurs
In this latest test version I've added a config option called file-encoding. Try adding this line to your config file:
file-encoding: "UTF-8"
Please update, latest version of Spigot.
@nisovin
Using version 1.12-Test2, I created a book with the name "The End" in red text using Essentials' /i command. Syntax was
/i book 1 name:&4The_End
In my inventory, everything was kosher. I placed the book in an admin shopkeeper's inventory and checked the trade menu; the title was still red. I then reloaded the plugin and checked the trade menu again, the title had metamorphosed into "?4The End"
What did I do wrong here, and what is the right way to get colors to work?
EDIT: Tried again with Test3. Now when I reload, the word "The" disappears entirely from the title of the book, leaving the in-game name displayed simply as "End." Looking at save.yml, the text is saved as "&4The End"
EDIT2: On the bright side, custom potions are working 100%. :)
EDIT3: Test4 version of the jar returns the behavior of saved color codes to the previous, e.g. "?4The End"
Hopefully you'll have a compatiblity for 1.5.1 today, because the latest builds rendered your plugin useless again. I don't know why you have to auto-disable it on version changes.
Sign shops doesnt work
the chest shop keeper is not working! when i created it, it doesn't allow me to buy the stuff that are inside the chest! help!
I discovered a significant bug, so here's yet another version:
http://nisovin.com/shopkeepers/Shopkeepers-1.12-Test4.jar
@rpundurs
In 1.12, colors should work fine. There's no need to modify the save.yml file.
@dotapurex1
Sorry, no. Adding exceptions like this would just add complexity and confusion. Trades must match exactly to be valid.
Does anyone know how to get colored text working for items with custom names/lore? I've tried manually editing save.yml to include & or §, but the encoding doesn't appear to support either of these symbols, replacing them with ? once saved and closed. Changing the config to any encoding (such as UTF-8) other than Western disables the plugin completely.
@RetroCharles
http://dev.bukkit.org/server-mods/shopkeepers/files/22-v1-12/
Any estimation of when this plugin will be updated to be usable in Minecraft 1.5
out of all my plugins in the server, this is the one i miss the most Lol
Please update :)
-Charles
Can you please make the shops accept heads without regards to its name?
Like i have a regular "steve" head but i want to also use a "Jacks" head to be able to trade for the same items in the shop.
Thanks!
Hey, love the plugin and all, but since 1.5 it seems as if I'm unable to use it. My server is currently running libigot, and Shopkeepers fails to load due to the severe error, "Incompatible server version", despite the version of server being 1.5
Is there any way you can add libigot compatibility or an option to ignore server version checking?
THANK YOU SO MUCH FOR UPDATING!
@2Andri
Oh really!? omg I want to see that.
Here's another, hopefully final, test version before I push the release. As before, it's a test build, please back up your save.yml file. This file is not approved by BukkitDev staff, use it at your own risk.
http://nisovin.com/shopkeepers/Shopkeepers-1.12-Test3.jar
@nisovin
Edit : Ok, the anvil button do not work if you do not Close/Reopen the editor before , cause the anvil button do not save recipes
Keep that work ,
Best regard,
Xephi
@DreamCastNetwork
I believe you can sell/buy custom items? And Enchanted books with the new TestBuild, atleast I can :P